001    /**
002     * Copyright 2005-2014 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.edl.impl.extract.dao;
017    
018    import java.util.List;
019    
020    import org.kuali.rice.edl.impl.extract.Dump;
021    import org.kuali.rice.edl.impl.extract.Fields;
022    
023    
024    public interface ExtractDAO {
025    
026        /**
027         * Returns a {@link Dump} for the given document id
028         * @param documentId the document id
029         * @return a {@link Dump}
030         */
031        public Dump getDumpByDocumentId(String documentId);
032    
033        /**
034         * Returns all {@link Fields} with the given document id.
035         * @param documentId the document id.
036         * @return a {@link List} of {@link Fields}
037         */
038        public List<Fields> getFieldsByDocumentId(String documentId);
039    
040        /**
041         * Persists the given item to the underlying datasource.
042         * @param dump the item to save
043         * @return the saved {@link Dump}
044         */
045        public Dump saveDump(Dump dump);
046    
047        /**
048         * Removes a {@link Dump} from the underlying datasource for the given document id.
049         * @param documentId the document id
050         */
051        public void deleteDump(String documentId);
052    
053        /**
054         * Persists the given item to the underlying datasource.
055         * @param field the item to save
056         * @return the saved {@link Fields}
057         */
058        public Fields saveField(Fields field);
059    
060    
061    
062    }