| org.kuali.module.gl.service.CorrectionDocumentService
All known Subclasses: org.kuali.module.gl.service.impl.CorrectionDocumentServiceImpl,
| CorrectionDocumentService | | public interface CorrectionDocumentService (Code) | | An interface declaring methods needed by the GLCP to function
|
| Method Summary | |
| public boolean | areInputOriginEntriesPersisted(CorrectionDocument document)
Returns true if the system is storing input origin entries for this class. | | public boolean | areOutputOriginEntriesPersisted(CorrectionDocument document)
Returns true if the system is storing output origin entries for this class. | | public CorrectionDocument | findByCorrectionDocumentHeaderId(String docId)
| | public List | findByDocumentHeaderIdAndCorrectionGroupNumber(String docId, int i)
| | public CorrectionChangeGroup | findByDocumentNumberAndCorrectionChangeGroupNumber(String docId, int i)
| | public List | findByDocumentNumberAndCorrectionGroupNumber(String docId, int i)
| | public Collection<CorrectionDocument> | getCorrectionDocumentsFinalizedOn(Date date)
| | public List<Column> | getTableRenderColumnMetadata(String docId)
Returns metadata to help render columns in the GLCP. | | public void | persistInputOriginEntriesForInitiatedOrSavedDocument(CorrectionDocument document, Iterator<OriginEntryFull> entries)
| | public void | persistOriginEntryGroupsForDocumentSave(CorrectionDocument document, CorrectionDocumentEntryMetadata correctionDocumentEntryMetadata)
| | public void | persistOutputOriginEntriesForInitiatedOrSavedDocument(CorrectionDocument document, Iterator<OriginEntryFull> entries)
| | public void | removePersistedInputOriginEntries(CorrectionDocument document)
| | public void | removePersistedInputOriginEntries(String docId)
| | public void | removePersistedOutputOriginEntries(CorrectionDocument document)
| | public void | removePersistedOutputOriginEntries(String docId)
| | public List<OriginEntryFull> | retrievePersistedInputOriginEntries(CorrectionDocument document, int abortThreshold)
Retrieves input origin entries that have been persisted for this document
Parameters:
document - the document
Parameters:
abortThreshold - if the file exceeds this number of rows, then null is returned. | | public Iterator<OriginEntryFull> | retrievePersistedInputOriginEntriesAsIterator(CorrectionDocument document)
Retrieves input origin entries that have been persisted for this document in an iterator. | | public List<OriginEntryFull> | retrievePersistedOutputOriginEntries(CorrectionDocument document, int abortThreshold)
Retrieves output origin entries that have been persisted for this document
Parameters:
document - the document
Parameters:
abortThreshold - if the file exceeds this number of rows, then null is returned. | | public Iterator<OriginEntryFull> | retrievePersistedOutputOriginEntriesAsIterator(CorrectionDocument document)
Retrieves output origin entries that have been persisted for this document in an iterator. | | public void | writePersistedInputOriginEntriesToStream(CorrectionDocument document, OutputStream out)
| | public void | writePersistedOutputOriginEntriesToStream(CorrectionDocument document, OutputStream out)
|
| CORRECTION_TYPE_CRITERIA | | final public static String CORRECTION_TYPE_CRITERIA(Code) | | |
| CORRECTION_TYPE_MANUAL | | final public static String CORRECTION_TYPE_MANUAL(Code) | | |
| CORRECTION_TYPE_REMOVE_GROUP_FROM_PROCESSING | | final public static String CORRECTION_TYPE_REMOVE_GROUP_FROM_PROCESSING(Code) | | |
| SYSTEM_DATABASE | | final public static String SYSTEM_DATABASE(Code) | | |
| areInputOriginEntriesPersisted | | public boolean areInputOriginEntriesPersisted(CorrectionDocument document)(Code) | | Returns true if the system is storing input origin entries for this class. Note that this does not mean that there's at least
one input origin entry record persisted for this document, but merely returns true if and only if the underlying persistence
mechanism has a record of this document's origin entries. See the docs for the implementations of this method for more
implementation specific details.
Parameters:
document - a GLCP document Returns true if system should store origin entries, false otherwise |
| areOutputOriginEntriesPersisted | | public boolean areOutputOriginEntriesPersisted(CorrectionDocument document)(Code) | | Returns true if the system is storing output origin entries for this class. Note that this does not mean that there's at
least one output origin entry record persisted for this document, but merely returns true if and only if the underlying
persistence mechanism has a record of this document's origin entries. See the docs for the implementations of this method for
more implementation specific details.
Parameters:
document - a GLCP document to query true if origin entries are stored to the system, false otherwise |
| findByCorrectionDocumentHeaderId | | public CorrectionDocument findByCorrectionDocumentHeaderId(String docId)(Code) | | Retrieves a correction document by the document id
Parameters:
docId - the document id of the GLCP to find a CorrectionDocument if found |
| findByDocumentHeaderIdAndCorrectionGroupNumber | | public List findByDocumentHeaderIdAndCorrectionGroupNumber(String docId, int i)(Code) | | Finds CollectionChange records associated with a given document id and correction change group
Parameters:
docId - the document id of a GLCP document
Parameters:
i - the number of the correction group within the document a List of qualifying CorrectionChange records |
| findByDocumentNumberAndCorrectionChangeGroupNumber | | public CorrectionChangeGroup findByDocumentNumberAndCorrectionChangeGroupNumber(String docId, int i)(Code) | | Returns a specific correction change group for a GLCP document
Parameters:
docId - the document id of a GLCP document
Parameters:
i - the number of the correction group within the document a CorrectionChangeGroup |
| findByDocumentNumberAndCorrectionGroupNumber | | public List findByDocumentNumberAndCorrectionGroupNumber(String docId, int i)(Code) | | Finds Collection Criteria associated with the given GLCP document and group
Parameters:
docId - the document id of a GLCP document
Parameters:
i - the number of the correction group within the document a List of qualifying CorrectionCriteria |
| getCorrectionDocumentsFinalizedOn | | public Collection<CorrectionDocument> getCorrectionDocumentsFinalizedOn(Date date)(Code) | | Retrieves all of the documents that were finalized on a certain date
Parameters:
date - the date to find GLCP documents finalized on a collection of documents |
| getTableRenderColumnMetadata | | public List<Column> getTableRenderColumnMetadata(String docId)(Code) | | Returns metadata to help render columns in the GLCP. Do not modify this list or the contents in this list.
Parameters:
docId - the document id of a GLCP document a List of Columns to render |
| persistInputOriginEntriesForInitiatedOrSavedDocument | | public void persistInputOriginEntriesForInitiatedOrSavedDocument(CorrectionDocument document, Iterator<OriginEntryFull> entries)(Code) | | This method persists an Iterator of input origin entries for a document that is in the initiated or saved state
Parameters:
document - an initiated or saved document
Parameters:
entries - an Iterator of origin entries |
| persistOriginEntryGroupsForDocumentSave | | public void persistOriginEntryGroupsForDocumentSave(CorrectionDocument document, CorrectionDocumentEntryMetadata correctionDocumentEntryMetadata)(Code) | | Saves the input and output origin entry groups for a document prior to saving the document
Parameters:
document - a GLCP document
Parameters:
correctionDocumentEntryMetadata - metadata about this GLCP document |
| persistOutputOriginEntriesForInitiatedOrSavedDocument | | public void persistOutputOriginEntriesForInitiatedOrSavedDocument(CorrectionDocument document, Iterator<OriginEntryFull> entries)(Code) | | This method persists an Iterator of input origin entries for a document that is in the initiated or saved state
Parameters:
document - an initiated or saved document
Parameters:
entries - an Iterator of OriginEntries to persist |
| removePersistedInputOriginEntries | | public void removePersistedInputOriginEntries(CorrectionDocument document)(Code) | | Removes input origin entries that were saved to the database associated with the given document
Parameters:
document - a GLCP document |
| removePersistedInputOriginEntries | | public void removePersistedInputOriginEntries(String docId)(Code) | | Removes input origin entries that were saved to the database associated with the given document
Parameters:
docId - the document id of a GLCP document |
| removePersistedOutputOriginEntries | | public void removePersistedOutputOriginEntries(CorrectionDocument document)(Code) | | Removes all output origin entries persisted in the database created by the given document
Parameters:
document - a GLCP document |
| removePersistedOutputOriginEntries | | public void removePersistedOutputOriginEntries(String docId)(Code) | | Removes all output origin entries persisted in the database created by the given document
Parameters:
docId - the document id of a GLCP document |
| retrievePersistedInputOriginEntries | | public List<OriginEntryFull> retrievePersistedInputOriginEntries(CorrectionDocument document, int abortThreshold)(Code) | | Retrieves input origin entries that have been persisted for this document
Parameters:
document - the document
Parameters:
abortThreshold - if the file exceeds this number of rows, then null is returned. UNLIMITED_ABORT_THRESHOLDsignifies that there is no limit the list, or null if there are too many origin entries
throws:
RuntimeException - several reasons, primarily relating to underlying persistence layer problems |
| retrievePersistedInputOriginEntriesAsIterator | | public Iterator<OriginEntryFull> retrievePersistedInputOriginEntriesAsIterator(CorrectionDocument document)(Code) | | Retrieves input origin entries that have been persisted for this document in an iterator. Implementations of this method may
choose to implement this method in a way that consumes very little memory.
Parameters:
document - the document the iterator
throws:
RuntimeException - several reasons, primarily relating to underlying persistence layer problems |
| retrievePersistedOutputOriginEntries | | public List<OriginEntryFull> retrievePersistedOutputOriginEntries(CorrectionDocument document, int abortThreshold)(Code) | | Retrieves output origin entries that have been persisted for this document
Parameters:
document - the document
Parameters:
abortThreshold - if the file exceeds this number of rows, then null is returned. UNLIMITED_ABORT_THRESHOLDsignifies that there is no limit the list, or null if there are too many origin entries
throws:
RuntimeException - several reasons, primarily relating to underlying persistence layer problems |
| retrievePersistedOutputOriginEntriesAsIterator | | public Iterator<OriginEntryFull> retrievePersistedOutputOriginEntriesAsIterator(CorrectionDocument document)(Code) | | Retrieves output origin entries that have been persisted for this document in an iterator. Implementations of this method may
choose to implement this method in a way that consumes very little memory.
Parameters:
document - the document the iterator
throws:
RuntimeException - several reasons, primarily relating to underlying persistence layer problems |
| writePersistedInputOriginEntriesToStream | | public void writePersistedInputOriginEntriesToStream(CorrectionDocument document, OutputStream out) throws IOException(Code) | | Writes out the persisted input origin entries in an
OutputStream in a flat file format
Parameters:
document - a GLCP document
Parameters:
out - an open and ready output stream
throws:
IOException - thrown if errors were encountered writing to the Stream
throws:
RuntimeException - several reasons, including if the entries are not persisted |
| writePersistedOutputOriginEntriesToStream | | public void writePersistedOutputOriginEntriesToStream(CorrectionDocument document, OutputStream out) throws IOException(Code) | | Writes out the persisted output origin entries in an
OutputStream in a flat file format\
Parameters:
document - a GLCP document
Parameters:
out - axn open and ready output stream
throws:
IOException - thrown if IOExceptions occurred in writing the persisted origin entries
throws:
RuntimeException - several reasons, including if the entries are not persisted |
|
|