org.kuali.kfs.gl.service
Interface EncumbranceService

All Known Implementing Classes:

EncumbranceServiceImpl

public interface EncumbranceService

An interface declaring services dealing with encumbrances

Method Summary

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.
Integer	getOpenEncumbranceRecordCount(Map fieldValues) This method gets 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) Purge an entire fiscal year for a single chart.
void	save(Encumbrance enc) Save an Encumbrance entry

Method Detail

save

void save(Encumbrance enc)

Save an Encumbrance entry

Parameters:

enc - an encumbrance entry

purgeYearByChart

void purgeYearByChart(String chartOfAccountsCode,
                      int year)

Purge an entire fiscal year for a single chart.

Parameters:

chartOfAccountsCode - the chart of encumbrances to purge

year - the year of encumbrances to purage

getAllEncumbrances

Iterator getAllEncumbrances()

Fetch all encumbrance records from GL open encumbrance table. Based on test data, there's only about a third as many encumbrances as there are, say, balances, so unless your institution is huge, it's probably safe to call this method.

Returns:

an Iterator of encumbrances

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

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)

This method gets 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