1 /**
2 * Copyright 2005-2014 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.edl.impl.extract.dao;
17
18 import java.util.List;
19
20 import org.kuali.rice.edl.impl.extract.Dump;
21 import org.kuali.rice.edl.impl.extract.Fields;
22
23
24 public interface ExtractDAO {
25
26 /**
27 * Returns a {@link Dump} for the given document id
28 * @param documentId the document id
29 * @return a {@link Dump}
30 */
31 public Dump getDumpByDocumentId(String documentId);
32
33 /**
34 * Returns all {@link Fields} with the given document id.
35 * @param documentId the document id.
36 * @return a {@link List} of {@link Fields}
37 */
38 public List<Fields> getFieldsByDocumentId(String documentId);
39
40 /**
41 * Persists the given item to the underlying datasource.
42 * @param dump the item to save
43 * @return the saved {@link Dump}
44 */
45 public Dump saveDump(Dump dump);
46
47 /**
48 * Removes a {@link Dump} from the underlying datasource for the given document id.
49 * @param documentId the document id
50 */
51 public void deleteDump(String documentId);
52
53 /**
54 * Persists the given item to the underlying datasource.
55 * @param field the item to save
56 * @return the saved {@link Fields}
57 */
58 public Fields saveField(Fields field);
59
60
61
62 }