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