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.mediapackage.MediaPackage;
24 import org.opencastproject.util.NotFoundException;
25
26 /**
27 * API that defines persistent storage of OAI-PMH.
28 */
29 public interface OaiPmhDatabase {
30 /**
31 * Stores or updates a mediapackage from the OAI-PMH persistence
32 *
33 * @param mediaPackage
34 * the mediapackage
35 * @param repository
36 * the OAI-PMH repository ID
37 * @throws OaiPmhDatabaseException
38 * if there is a problem communicating with the underlying data store
39 */
40 void store(MediaPackage mediaPackage, String repository) throws OaiPmhDatabaseException;
41
42 /**
43 * Marks a existing mediapackage as deleted
44 *
45 * @param mediaPackageId
46 * the mediapackage id
47 * @param repository
48 * the OAI-PMH repository ID
49 * @throws NotFoundException
50 * if the mediapackage does not exist
51 * @throws OaiPmhDatabaseException
52 * if there is a problem communicating with the underlying data store
53 */
54 void delete(String mediaPackageId, String repository) throws OaiPmhDatabaseException, NotFoundException;
55
56 /**
57 * Searches mediapackages from the OAI-PMH persistence storage
58 *
59 * @param q
60 * the query
61 * @return a search result
62 */
63 SearchResult search(Query q);
64 }