org.kuali.kfs.gl.service
Interface GlCorrectionProcessOriginEntryService

All Known Implementing Classes:

GlCorrectionProcessOriginEntryServiceImpl

public interface GlCorrectionProcessOriginEntryService

Implementations of this interface are used to store a list of origin entries to be used by the GLCP. These persisted entries are 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 session in that origin entries can be stored, but data can be cleared out after a specific lifetime.

Method Summary

void	persistAllEntries(String glcpSearchResuiltsSequenceNumber, List<OriginEntryFull> allEntries) Persists the origin entries under a given sequence number.
List<OriginEntryFull>	retrieveAllEntries(String glcpSearchResuiltsSequenceNumber) Retrieves the origin entries stored under the given sequence number

Method Detail

retrieveAllEntries

List<OriginEntryFull> retrieveAllEntries(String glcpSearchResuiltsSequenceNumber)
                                         throws Exception

Retrieves the origin entries stored under the given sequence number

Parameters:

glcpSearchResuiltsSequenceNumber - a sequence number

Returns:

a list of origin entries, or null if no results are currently not in the system.

Throws:

Exception - thrown if something goes wrong

persistAllEntries

void persistAllEntries(String glcpSearchResuiltsSequenceNumber,
                       List<OriginEntryFull> allEntries)
                       throws Exception

Persists the origin entries under a given sequence number. If entries are persisted again under the same sequence number, then they will be overridden.

Parameters:

glcpSearchResuiltsSequenceNumber - a sequence number

allEntries - a list of origin entries

Throws:

Exception - thrown if anything goes wrong