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.smil.api;
23
24 import org.opencastproject.smil.entity.api.Smil;
25 import org.opencastproject.smil.entity.api.SmilObject;
26
27 import javax.xml.bind.JAXBException;
28
29 /**
30 * {@link SmilService} response container for {@link Smil} and
31 * {@link SmilObject}s as entities.
32 */
33 public interface SmilResponse {
34
35 /**
36 * Returns {@link Smil} object from response.
37 *
38 * @return {@link Smil} object
39 */
40 Smil getSmil();
41
42 /**
43 * Returns number of entities defined with this response.
44 *
45 * @return number of entities
46 */
47 int getEntitiesCount();
48
49 /**
50 * Returns {@link SmilObject} if only one entity stored. Throws
51 * {@link SmilException} otherwise.
52 *
53 * @return {@link SmilObject}
54 * @throws SmilException if entities count not one
55 */
56 SmilObject getEntity() throws SmilException;
57
58 /**
59 * Returns {@link SmilObject}s if there are any or throws
60 * {@link SmilException}.
61 *
62 * @return {@link SmilObject}s as array
63 * @throws SmilException if there are no entities defined by response.
64 */
65 SmilObject[] getEntities() throws SmilException;
66
67 /**
68 * Return XML serialized instance of this {@link SmilResponse}.
69 *
70 * @return {@link SmilResponse} as XML
71 * @throws JAXBException if serialization failed
72 */
73 String toXml() throws JAXBException;
74 }