org.kuali.kfs.gl.dataaccess
Interface OriginEntryDao

All Known Subinterfaces:

LaborOriginEntryDao

All Known Implementing Classes:

LaborOriginEntryDaoOjb, OriginEntryDaoOjb

public interface OriginEntryDao

Field Summary

static int	SORT_ACCOUNT Sort origin entries by account number
static int	SORT_DOCUMENT Sort origin entries by document id
static int	SORT_LISTING_REPORT Sort origin entries by listing report order (by fiscal year, chart code, account number, etc.: the order you see them in in generated text files)
static int	SORT_REPORT Sort origin entries by standard report order (by document type code and system origination code)

Method Summary

void	deleteEntry(OriginEntryInformation oe) Delete an entry
void	deleteGroups(Collection<OriginEntryGroup> groups) Delete all the groups in the list.
void	deleteMatchingEntries(Map searchCriteria) Delete entries that match criteria
Iterator<OriginEntryFull>	getBadBalanceEntries(Collection groups) Get bad balance entries; bad because a) they have invalid balance types, and b) because they revert the balances back to their stone age selves
Iterator	getDocumentsByGroup(OriginEntryGroup oeg) Return an iterator to all document keys reference by origin entries in a given group
<T> Iterator<T>	getEntriesByGroup(OriginEntryGroup oeg, int sort) Return an iterator to all the entries in a group
OriginEntryFull	getExactMatchingEntry(Integer entryId) Finds an entry for the given entryId, or returns a newly created on
Integer	getGroupCount(Integer groupId) Counts the number of entries in a group
Iterator	getGroupCounts() Counts of rows of all the origin entry groups
org.kuali.rice.kns.util.KualiDecimal	getGroupTotal(Integer groupId, boolean isCredit) Get the total amount of transactions in a group
Iterator	getMatchingEntries(Map searchCriteria) Iterator of entries that match criteria
Collection<OriginEntryFull>	getMatchingEntriesByCollection(Map searchCriteria) Collection of entries that match criteria
Iterator	getPosterOutputSummaryByGroupId(Collection groups) get the summarized information of poster input entries that belong to the entry groups with the given group id list
Iterator	getSummaryByGroupId(Collection groupIdList) get the summarized information of the entries that belong to the entry groups with the given group ids
void	saveOriginEntry(OriginEntryInformation entry) Save origin entry
Collection	testingGetAllEntries() This method should only be used in unit tests.

Field Detail

SORT_DOCUMENT

static final int SORT_DOCUMENT

Sort origin entries by document id

See Also:

Constant Field Values

SORT_ACCOUNT

static final int SORT_ACCOUNT

Sort origin entries by account number

See Also:

Constant Field Values

SORT_REPORT

static final int SORT_REPORT

Sort origin entries by standard report order (by document type code and system origination code)

See Also:

Constant Field Values

SORT_LISTING_REPORT

static final int SORT_LISTING_REPORT

Sort origin entries by listing report order (by fiscal year, chart code, account number, etc.: the order you see them in in generated text files)

See Also:

Constant Field Values

Method Detail

getGroupTotal

org.kuali.rice.kns.util.KualiDecimal getGroupTotal(Integer groupId,
                                                   boolean isCredit)

Get the total amount of transactions in a group

Parameters:

the - id of the origin entry group to total

isCredit - whether the total should be of credits or not

Returns:

the sum of all queried origin entries

getGroupCount

Integer getGroupCount(Integer groupId)

Counts the number of entries in a group

Parameters:

the - id of an origin entry group

Returns:

the count of the entries in that group

getGroupCounts

Iterator getGroupCounts()

Counts of rows of all the origin entry groups

Returns:

iterator of Object[] {[BigDecimal id,BigDecimal count]}

deleteEntry

void deleteEntry(OriginEntryInformation oe)

Delete an entry

Parameters:

oe - Entry to delete

getDocumentsByGroup

Iterator getDocumentsByGroup(OriginEntryGroup oeg)

Return an iterator to all document keys reference by origin entries in a given group

Parameters:

oeg - Group the origin entry group to find entries in, by origin entry

Returns:

Iterator of java.lang.Object[] with report data about all of the distinct document numbers/type code/origination code combinations of origin entries in the group

getEntriesByGroup

<T> Iterator<T> getEntriesByGroup(OriginEntryGroup oeg,
                                  int sort)

Return an iterator to all the entries in a group

Parameters:

oeg - the origin entry group to get entries in

sort - the Sort Order (one of the Sort Orders defined by the SORT_ constants defined in this class)

Returns:

Iterator of entries in the specified group

getBadBalanceEntries

Iterator<OriginEntryFull> getBadBalanceEntries(Collection groups)

Get bad balance entries; bad because a) they have invalid balance types, and b) because they revert the balances back to their stone age selves

Parameters:

groups - a Collection of groups to remove bad entries in

Returns:

an Iterator of no good, won't use, bad balance entries

getMatchingEntriesByCollection

Collection<OriginEntryFull> getMatchingEntriesByCollection(Map searchCriteria)

Collection of entries that match criteria

Parameters:

searchCriteria - Map of field, value pairs

Returns:

collection of entries

getMatchingEntries

Iterator getMatchingEntries(Map searchCriteria)

Iterator of entries that match criteria

Parameters:

searchCriteria - Map of field, value pairs

Returns:

collection of entries

deleteMatchingEntries

void deleteMatchingEntries(Map searchCriteria)

Delete entries that match criteria

Parameters:

searchCriteria - Map of field, value pairs

deleteGroups

void deleteGroups(Collection<OriginEntryGroup> groups)

Delete all the groups in the list. This will delete the entries. The OriginEntryGroupDao has a method to delete the groups

Parameters:

groups - a Collection of Origin Entry Groups to delete entries in

saveOriginEntry

void saveOriginEntry(OriginEntryInformation entry)

Save origin entry

Parameters:

entry - entry to save

getExactMatchingEntry

OriginEntryFull getExactMatchingEntry(Integer entryId)

Finds an entry for the given entryId, or returns a newly created on

Parameters:

entryId - an entry id to find an entry for

Returns:

the entry for the given entry id, or a newly created entry

getSummaryByGroupId

Iterator getSummaryByGroupId(Collection groupIdList)

get the summarized information of the entries that belong to the entry groups with the given group ids

Parameters:

groupIdList - the ids of origin entry groups

Returns:

a set of summarized information of the entries within the specified groups

testingGetAllEntries

Collection testingGetAllEntries()

This method should only be used in unit tests. It loads all the gl_origin_entry_t rows in memory into a collection. This won't scale for production.

Returns:

a Collection with every single origin entry in the database

getPosterOutputSummaryByGroupId

Iterator getPosterOutputSummaryByGroupId(Collection groups)

get the summarized information of poster input entries that belong to the entry groups with the given group id list

Parameters:

groups - the origin entry groups

Returns:

a set of summarized information of poster input entries within the specified groups