org.kuali.kfs.gl.dataaccess
Interface EncumbranceDao

All Known Implementing Classes:

EncumbranceDaoOjb

public interface EncumbranceDao

A DAO interface that declares methods needed for Encumbrances to interact with the database

Method Summary

Integer	findCountGreaterOrEqualThan(Integer year)
Iterator	findOpenEncumbrance(Map fieldValues) This method finds the open encumbrances according to input fields and values
Iterator	getAllEncumbrances() fetch all encumbrance records from GL open encumbrance table
Encumbrance	getEncumbranceByTransaction(Transaction t) Returns an encumbrance that would be affected by the given transaction
Iterator	getEncumbrancesToClose(Integer fiscalYear) Returns an Iterator of all encumbrances that need to be closed for the fiscal year
Integer	getOpenEncumbranceRecordCount(Map fieldValues) Counts the number of the open encumbrances according to input fields and values
Iterator	getSummarizedEncumbrances(String documentTypeCode, boolean included) group all encumbrances with/without the given document type code by fiscal year, chart, account, sub-account, object code, sub object code, and balance type code, and summarize the encumbrance amount and the encumbrance close amount.
void	purgeYearByChart(String chartOfAccountsCode, int year) Purges the database of all those encumbrances with the given chart and year
void	save(Encumbrance e) Saves an encumbrance to the database

Method Detail

getEncumbranceByTransaction

Encumbrance getEncumbranceByTransaction(Transaction t)

Returns an encumbrance that would be affected by the given transaction

Parameters:

t - the transaction to find the affected encumbrance for

Returns:

an Encumbrance that would be affected by the posting of the transaction, or null

getEncumbrancesToClose

Iterator getEncumbrancesToClose(Integer fiscalYear)

Returns an Iterator of all encumbrances that need to be closed for the fiscal year

Parameters:

fiscalYear - a fiscal year to find encumbrances for

Returns:

an Iterator of encumbrances to close

purgeYearByChart

void purgeYearByChart(String chartOfAccountsCode,
                      int year)

Purges the database of all those encumbrances with the given chart and year

Parameters:

chartOfAccountsCode - the chart of accounts code purged encumbrances will have

year - the university fiscal year purged encumbrances will have

save

void save(Encumbrance e)

Saves an encumbrance to the database

Parameters:

e - an encumbrance to save

getAllEncumbrances

Iterator getAllEncumbrances()

fetch all encumbrance records from GL open encumbrance table

Returns:

an Iterator with all encumbrances currently in the database

getSummarizedEncumbrances

Iterator getSummarizedEncumbrances(String documentTypeCode,
                                   boolean included)

group all encumbrances with/without the given document type code by fiscal year, chart, account, sub-account, object code, sub object code, and balance type code, and summarize the encumbrance amount and the encumbrance close amount.

Parameters:

documentTypeCode - the given document type code

included - indicate if all encumbrances with the given document type are included in the results or not

Returns:

an Iterator of arrays of java.lang.Objects holding summarization data about qualifying encumbrances

findOpenEncumbrance

Iterator findOpenEncumbrance(Map fieldValues)

This method finds the open encumbrances according to input fields and values

Parameters:

fieldValues - the input fields and values

Returns:

a collection of open encumbrances

getOpenEncumbranceRecordCount

Integer getOpenEncumbranceRecordCount(Map fieldValues)

Counts the number of the open encumbrances according to input fields and values

Parameters:

fieldValues - the input fields and values

Returns:

the number of the open encumbrances

findCountGreaterOrEqualThan

Integer findCountGreaterOrEqualThan(Integer year)

Parameters:

year - the given university fiscal year

Returns:

count of rows for the given fiscal year