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.oaipmh.persistence;
22
23 import org.opencastproject.metadata.dublincore.DublinCoreCatalog;
24
25 /**
26 * The OAI-PMH media package element result item
27 */
28 public interface SearchResultElementItem {
29
30 /**
31 * @return the type of the media package element
32 */
33 String getType();
34
35 /**
36 * @return the flavor of the media package element
37 */
38 String getFlavor();
39
40 /**
41 * @return the XML serialized content of the media package element
42 */
43 String getXml();
44
45 /**
46 * @return true, if the content is an episode dublincore catalog, false otherwise
47 */
48 boolean isEpisodeDublinCore();
49
50 /**
51 * @return true, if the content is a series dublincore catalog, false otherwise
52 */
53 boolean isSeriesDublinCore();
54
55 /**
56 * Parse and return the content as dublincore catalog.
57 * This method can be called only if {@link #isEpisodeDublinCore()} or {@link #isSeriesDublinCore()} returns true
58 *
59 * @return the serialized content as dublincore catalog
60 * @throws OaiPmhDatabaseException if parsing dublincore catalog fail
61 */
62 DublinCoreCatalog asDublinCore() throws OaiPmhDatabaseException;
63 }