001    /*
002     * Copyright 2011 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.kfs.gl.service;
017    
018    import java.util.List;
019    
020    import org.kuali.kfs.gl.businessobject.OriginEntryFull;
021    
022    /**
023     * Implementations of this interface are used to store a list of origin entries to be used by the GLCP. These persisted entries are
024     * not stored permanently, but are stored for a period of time during the page views of a GLCP document. This is similar to a HTTP
025     * session in that origin entries can be stored, but data can be cleared out after a specific lifetime.
026     */
027    public interface GlCorrectionProcessOriginEntryService {
028    
029    
030        /**
031         * Retrieves the origin entries stored under the given sequence number
032         * 
033         * @param glcpSearchResuiltsSequenceNumber a sequence number
034         * @return a list of origin entries, or null if no results are currently not in the system.
035         * @throws Exception thrown if something goes wrong
036         */
037        public List<OriginEntryFull> retrieveAllEntries(String glcpSearchResuiltsSequenceNumber) throws Exception;
038    
039        /**
040         * Persists the origin entries under a given sequence number. If entries are persisted again under the same sequence number,
041         * then they will be overridden.
042         * 
043         * @param glcpSearchResuiltsSequenceNumber a sequence number
044         * @param allEntries a list of origin entries
045         * @throws Exception thrown if anything goes wrong
046         */
047        public void persistAllEntries(String glcpSearchResuiltsSequenceNumber, List<OriginEntryFull> allEntries) throws Exception;
048    }