1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22
23 package org.opencastproject.mediapackage;
24
25 import org.w3c.dom.Document;
26 import org.w3c.dom.Node;
27
28 /**
29 * To be implemented by everyone who wishes to contribute to the media package manifest.
30 */
31 public interface ManifestContributor {
32
33 /**
34 * This method returns an XML serialization of the object to be stored in the media package manifest. It should be
35 * possible to reconstruct the object from this data.
36 * <p>
37 * For creating <em>{@link MediaPackageElement}s</em> from a manifest, please use
38 * {@link MediaPackageElementBuilder#elementFromManifest(org.w3c.dom.Node, MediaPackageSerializer)}. All other objects
39 * shall provide their own implementation specific reconstruction mechanism.
40 *
41 * @param document
42 * the parent
43 * @param serializer
44 * the media package serializer
45 * @return the object's xml representation
46 * @throws MediaPackageException
47 * if the mediapackage can't be serialized
48 */
49 Node toManifest(Document document, MediaPackageSerializer serializer) throws MediaPackageException;
50
51 }