1 /*
2 * Copyright 2007 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.ole.gl.service;
17
18 import java.util.List;
19
20 import org.kuali.ole.gl.businessobject.OriginEntryFull;
21
22 /**
23 * Implementations of this interface are used to store a list of origin entries to be used by the GLCP. These persisted entries are
24 * 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
25 * session in that origin entries can be stored, but data can be cleared out after a specific lifetime.
26 */
27 public interface GlCorrectionProcessOriginEntryService {
28
29
30 /**
31 * Retrieves the origin entries stored under the given sequence number
32 *
33 * @param glcpSearchResuiltsSequenceNumber a sequence number
34 * @return a list of origin entries, or null if no results are currently not in the system.
35 * @throws Exception thrown if something goes wrong
36 */
37 public List<OriginEntryFull> retrieveAllEntries(String glcpSearchResuiltsSequenceNumber) throws Exception;
38
39 /**
40 * Persists the origin entries under a given sequence number. If entries are persisted again under the same sequence number,
41 * then they will be overridden.
42 *
43 * @param glcpSearchResuiltsSequenceNumber a sequence number
44 * @param allEntries a list of origin entries
45 * @throws Exception thrown if anything goes wrong
46 */
47 public void persistAllEntries(String glcpSearchResuiltsSequenceNumber, List<OriginEntryFull> allEntries) throws Exception;
48 }