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  package org.opencastproject.scheduler.api;
22  
23  import com.entwinemedia.fn.data.Opt;
24  
25  import java.util.Date;
26  import java.util.Map;
27  import java.util.Set;
28  
29  /**
30   * Defines the technical metadata of an scheduled event
31   */
32  public interface TechnicalMetadata {
33  
34    /**
35     * Returns the event identifier
36     *
37     * @return the event identifier
38     */
39    String getEventId();
40  
41    /**
42     * Returns the agent identifier
43     *
44     * @return the agent identifier
45     */
46    String getAgentId();
47  
48    /**
49     * Returns the start date
50     *
51     * @return the start date
52     */
53    Date getStartDate();
54  
55    /**
56     * Returns the end date
57     *
58     * @return the end date
59     */
60    Date getEndDate();
61  
62    /**
63     * Returns the list of presenters
64     *
65     * @return the list of presenters
66     */
67    Set<String> getPresenters();
68  
69    /**
70     * Returns the optional recording
71     *
72     * @return the optional recording
73     */
74    Opt<Recording> getRecording();
75  
76    /**
77     * Returns the workflow properties
78     *
79     * @return the workflow properties
80     */
81    Map<String, String> getWorkflowProperties();
82  
83    /**
84     * Returns the capture agent configuration
85     *
86     * @return the capture agent configuration
87     */
88    Map<String, String> getCaptureAgentConfiguration();
89  
90  }