| org.kuali.module.gl.service.OriginEntryService
All known Subclasses: org.kuali.module.gl.service.impl.OriginEntryServiceImpl,
| OriginEntryService | | public interface OriginEntryService (Code) | | An interface of methods to interact with Origin Entries
|
| Method Summary | |
| public OriginEntryGroup | copyEntries(Date date, String sourceCode, boolean valid, boolean process, boolean scrub, Collection<OriginEntryFull> entries)
| | public OriginEntryGroup | copyEntries(Date date, String sourceCode, boolean valid, boolean process, boolean scrub, Iterator<OriginEntryFull> entries)
Copy a set of entries into a new group. | | public void | createEntry(Transaction tran, OriginEntryGroup group)
| | public void | delete(OriginEntryFull oe)
| | public void | exportFlatFile(String filename, Integer groupId)
| | public void | flatFile(Integer groupId, BufferedOutputStream bw)
| | public void | flatFile(Iterator<OriginEntryFull> entries, BufferedOutputStream bw)
writes out a list of origin entries to an output stream. | | public Iterator<OriginEntryFull> | getBadBalanceEntries(Collection groups)
| | public Collection<OriginEntryFull> | getDocumentsByGroup(OriginEntryGroup oeg)
This returns all of distinct primary key sets of documents that created origin entries that exist
in the given origin entry group. | | public Iterator<OriginEntryFull> | getEntriesByDocument(OriginEntryGroup oeg, String documentNumber, String documentTypeCode, String originCode)
| | public Iterator<OriginEntryFull> | getEntriesByGroup(OriginEntryGroup oeg)
| | public Iterator<OriginEntryFull> | getEntriesByGroupAccountOrder(OriginEntryGroup oeg)
| | public List<OriginEntryFull> | getEntriesByGroupId(Integer groupId)
| | public Iterator<OriginEntryFull> | getEntriesByGroupListingReportOrder(OriginEntryGroup oeg)
Return all entries for a group sorted across the columns in report from left to right. | | public Iterator<OriginEntryFull> | getEntriesByGroupReportOrder(OriginEntryGroup oeg)
Return all entries for a group sorted for display on the pending entry report. | | public OriginEntryFull | getExactMatchingEntry(Integer entryId)
| | public Integer | getGroupCount(Integer groupId)
| | public Collection<OriginEntryFull> | getMatchingEntriesByCollection(Map searchCriteria)
| | public Map<String, PosterOutputSummaryEntry> | getPosterOutputSummaryByGroupId(Collection groupIdList)
| | public OriginEntryStatistics | getStatistics(Integer groupId)
| | public LedgerEntryHolder | getSummaryByGroupId(Collection groupIdList)
| | public void | loadFlatFile(String filename, String groupSourceCode, boolean valid, boolean processed, boolean scrub)
| | public void | save(OriginEntryFull entry)
|
| copyEntries | | public OriginEntryGroup copyEntries(Date date, String sourceCode, boolean valid, boolean process, boolean scrub, Collection<OriginEntryFull> entries)(Code) | | Copy a set of entries into a new group
Parameters:
date - the date that the copied entries should list as their post date
Parameters:
sourceCode - the source code of the origin entry group to create
Parameters:
valid - whether the new group should be considered valid
Parameters:
process - whether the new group should be ready to be processed
Parameters:
scrub - whether the new group should be processed by the scrubber
Parameters:
entries - a Collection of entries to copy a new origin entry full of copied entries |
| copyEntries | | public OriginEntryGroup copyEntries(Date date, String sourceCode, boolean valid, boolean process, boolean scrub, Iterator<OriginEntryFull> entries)(Code) | | Copy a set of entries into a new group. This method can use less space than the method that takes in a collection, because
iterators can be implemented to load data one chunk at a time, similar to how java ResultSets work.
Parameters:
date - the date that the copied entries should list as their post date
Parameters:
sourceCode - the source code of the origin entry group to create
Parameters:
valid - whether the new group should be considered valid
Parameters:
process - whether the new group should be ready to be processed
Parameters:
scrub - whether the new group should be processed by the scrubber
Parameters:
entries - a Iterator of entries to copy a new origin entry full of copied entries |
| createEntry | | public void createEntry(Transaction tran, OriginEntryGroup group)(Code) | | Take a generic transaction and save it as an origin entry in a specific group
Parameters:
tran - transaction to save
Parameters:
group - group to save the transaction |
| exportFlatFile | | public void exportFlatFile(String filename, Integer groupId)(Code) | | Export all origin entries in a group to a flat text file
Parameters:
filename - Filename to save the text
Parameters:
groupId - Group to save |
| flatFile | | public void flatFile(Integer groupId, BufferedOutputStream bw)(Code) | | Write all of the origin entries in a group to an output stream
Parameters:
groupId - the id of the origin entry group to get entries from
Parameters:
bw - the output stream to dump the entries as text to |
| flatFile | | public void flatFile(Iterator<OriginEntryFull> entries, BufferedOutputStream bw)(Code) | | writes out a list of origin entries to an output stream.
Parameters:
entries - an Iterator of entries to save as text
Parameters:
bw - the output stream to write origin entries to |
| getBadBalanceEntries | | public Iterator<OriginEntryFull> getBadBalanceEntries(Collection groups)(Code) | | Return all entries for the groups where the balance type is empty
Parameters:
groups - a Collection of groups to look through all the entries of an Iterator of entries without balance types |
| getDocumentsByGroup | | public Collection<OriginEntryFull> getDocumentsByGroup(OriginEntryGroup oeg)(Code) | | This returns all of distinct primary key sets of documents that created origin entries that exist
in the given origin entry group. It returns this information in OriginEntryFull objects
that just don't have any other information besides the document keys (doc number, doc type code,
and origination code) filled in.
Parameters:
oeg - the group with the origin entries to get the documents of Collection to qualifying documents |
| getEntriesByDocument | | public Iterator<OriginEntryFull> getEntriesByDocument(OriginEntryGroup oeg, String documentNumber, String documentTypeCode, String originCode)(Code) | | Return all the entries for a specific document in a specific group
Parameters:
oeg - an origin entry group to find entries in
Parameters:
documentNumber - the document number of entries to select
Parameters:
documentTypeCode - the document type of entries to select
Parameters:
originCode - the origination code of entries to select iterator to all the qualifying entries |
| getEntriesByGroupAccountOrder | | public Iterator<OriginEntryFull> getEntriesByGroupAccountOrder(OriginEntryGroup oeg)(Code) | | Return all entries for a group sorted by account number for the error
Parameters:
oeg - an origin entry group to get entries from an Iterator of origin entries sorted by account number |
| getEntriesByGroupId | | public List<OriginEntryFull> getEntriesByGroupId(Integer groupId)(Code) | | Retrieves a list of origin entries that are in a given group
Parameters:
groupId - the id of the group to get all entries from a List of Origin Entries |
| getEntriesByGroupListingReportOrder | | public Iterator<OriginEntryFull> getEntriesByGroupListingReportOrder(OriginEntryGroup oeg)(Code) | | Return all entries for a group sorted across the columns in report from left to right.
Parameters:
oeg - an origin entry group to get entries from an Iterator of origin entries sorted in the proper order |
| getEntriesByGroupReportOrder | | public Iterator<OriginEntryFull> getEntriesByGroupReportOrder(OriginEntryGroup oeg)(Code) | | Return all entries for a group sorted for display on the pending entry report.
Parameters:
oeg - a origin entry group to get entries from an Iterator of origin entries sorted in the order needed for an origin entry report (fiscal year, chart, account, sub account, object, sub object) |
| getExactMatchingEntry | | public OriginEntryFull getExactMatchingEntry(Integer entryId)(Code) | | Returns the entry with the given id
Parameters:
entryId - the id of the entry to retrieve the origin entry if found, or null otherwise |
| getGroupCount | | public Integer getGroupCount(Integer groupId)(Code) | | Get count of transactions in a group
Parameters:
groupId - the group to get the count of entries from a count of entries |
| getMatchingEntriesByCollection | | public Collection<OriginEntryFull> getMatchingEntriesByCollection(Map searchCriteria)(Code) | | Finds all origin entries matching certain criteria; basically a catch-all origin entry search
Parameters:
searchCriteria - the criteria to be used in forming a query a Collection of qualifying origin entries |
| getPosterOutputSummaryByGroupId | | public Map<String, PosterOutputSummaryEntry> getPosterOutputSummaryByGroupId(Collection groupIdList)(Code) | | get the summarized information of poster input entries that belong to the entry groups with the given group id list
Parameters:
groupIdList - the origin entry groups a map of summarized information of poster input entries within the specified groups |
| getStatistics | | public OriginEntryStatistics getStatistics(Integer groupId)(Code) | | Get statistics from a group
Parameters:
groupId - the id of a group of origin entries a collection of OriginEntryStatistics |
| getSummaryByGroupId | | public LedgerEntryHolder getSummaryByGroupId(Collection groupIdList)(Code) | | get the summarized information of the entries that belong to the entry groups with the given group id list
Parameters:
groupIdList - the origin entry groups a set of summarized information of the entries within the specified group |
| loadFlatFile | | public void loadFlatFile(String filename, String groupSourceCode, boolean valid, boolean processed, boolean scrub)(Code) | | Load a flat file of transations into the origin entry table (creating a new origin entry group in the process)
Parameters:
filename - Filename with the text
Parameters:
groupSourceCode - Source of the new group
Parameters:
valid - Valid flag for new group
Parameters:
processed - Process flag for new group
Parameters:
scrub - Scrub flag for new group |
| save | | public void save(OriginEntryFull entry)(Code) | | Save an origin entry
Parameters:
entry - the entry to save |
|
|