View Javadoc
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  package org.opencastproject.metadata.api;
23  
24  import java.util.Date;
25  
26  /**
27   * Provides metadata for a {@link MediaPackageMetadata}
28   *
29   */
30  public interface MediaPackageMetadata {
31  
32    /**
33     * Returns the title for the associated series, if any.
34     *
35     * @return The series title
36     */
37    String getSeriesTitle();
38  
39    /**
40     * Returns the title of the episode that this mediapackage represents.
41     *
42     * @return The episode title
43     */
44    String getTitle();
45  
46    /**
47     * The names of the creators. If no creators were specified, an empty array is returned.
48     *
49     * @return the creators for this mediapackage
50     */
51    String[] getCreators();
52  
53    /**
54     * The series, if any, that this episode belongs to.
55     *
56     * @return the series for this mediapackage
57     */
58    String getSeriesIdentifier();
59  
60    /**
61     * The license under which this episode is available
62     *
63     * @return the license for this mediapackage
64     */
65    String getLicense();
66  
67    /**
68     * The contributors. If no contributors were specified, an empty array is returned.
69     *
70     * @return the contributors for this mediapackage
71     */
72    String[] getContributors();
73  
74    /**
75     * The language spoken in the media
76     *
77     * @return the language for this mediapackage
78     */
79    String getLanguage();
80  
81    /**
82     * The subjects. If no subjects were specified, an empty array is returned.
83     *
84     * @return the subjects for this mediapackage
85     */
86    String[] getSubjects();
87  
88    /**
89     * Returns the media package start time.
90     *
91     * @return the start time
92     */
93    Date getDate();
94  
95  }