org.kuali.kfs.gl.service.impl

Class EncumbranceServiceImpl

java.lang.Object

org.kuali.kfs.gl.service.impl.EncumbranceServiceImpl

All Implemented Interfaces:

EncumbranceService

@Transactional
public class EncumbranceServiceImpl
extends Object
implements EncumbranceService

The base implementation of EncumbranaceService

Constructor Summary

Constructors

Constructor and Description
EncumbranceServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Iterator	findOpenEncumbrance(Map fieldValues, boolean includeZeroEncumbrances) Given the fieldValues, forms a query and finds the open encumbrances that match it
Iterator	getAllEncumbrances() Returns an iterator with all encumbrances from the database.
Integer	getOpenEncumbranceRecordCount(Map fieldValues, boolean includeZeroEncumbrances) Returns the count of all open encumbrances in the database, matching the given field 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.
boolean	hasSummarizedOpenEncumbranceRecords(Map fieldValues, boolean includeZeroEncumbrances) Finds open encumbrances that have the keys given in the map summarized by balance type codes where the sum(ACCOUNT_LINE_ENCUMBRANCE_AMOUNT - sum(ACCOUNT_LINE_ENCUMBRANCE_CLOSED_AMOUNT ) != 0 and returns true if there are any results.
void	purgeYearByChart(String chartOfAccountsCode, int year) Removes all encumbrances from the database having a certain chart and fiscal year
void	save(Encumbrance enc) Saves an encumbrance
void	setEncumbranceDao(EncumbranceDao ed) Field accessor for EncumbranceDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EncumbranceServiceImpl

public EncumbranceServiceImpl()

Method Detail

save

public void save(Encumbrance enc)

Saves an encumbrance

Specified by:

save in interface EncumbranceService

Parameters:

enc - an encumbrance to save

See Also:

EncumbranceService.save(org.kuali.kfs.gl.businessobject.Encumbrance)

purgeYearByChart

public void purgeYearByChart(String chartOfAccountsCode,
                    int year)

Removes all encumbrances from the database having a certain chart and fiscal year

Specified by:

purgeYearByChart in interface EncumbranceService

Parameters:

chartOfAccountsCode - the chart of encumbrances to purge

year - the year of encumbrances to purge

See Also:

EncumbranceService.purgeYearByChart(java.lang.String, int)

getAllEncumbrances

public Iterator getAllEncumbrances()

Returns an iterator with all encumbrances from the database.

Specified by:

getAllEncumbrances in interface EncumbranceService

Returns:

an Iterator of all encumbrances

See Also:

EncumbranceService.getAllEncumbrances()

setEncumbranceDao

public void setEncumbranceDao(EncumbranceDao ed)

Field accessor for EncumbranceDao

Parameters:

ed -

getSummarizedEncumbrances

public 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.

Specified by:

getSummarizedEncumbrances in interface EncumbranceService

Parameters:

documentTypeCode - the given document type code

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

See Also:

EncumbranceService.getSummarizedEncumbrances(java.lang.String, boolean)

findOpenEncumbrance

public Iterator findOpenEncumbrance(Map fieldValues,
                           boolean includeZeroEncumbrances)

Given the fieldValues, forms a query and finds the open encumbrances that match it

Specified by:

findOpenEncumbrance in interface EncumbranceService

Parameters:

fieldValues - the values to form an encumbrance query out of

includeZeroEncumbrances -

Returns:

an Iterator full of qualifying encumbrances

See Also:

org.kuali.kfs.gl.service.EncumbranceService#findOpenEncumbrance(java.util.Map)

getOpenEncumbranceRecordCount

public Integer getOpenEncumbranceRecordCount(Map fieldValues,
                                    boolean includeZeroEncumbrances)

Returns the count of all open encumbrances in the database, matching the given field values

Specified by:

getOpenEncumbranceRecordCount in interface EncumbranceService

Parameters:

fieldValues - the field values to build an encumbrance query out of

includeZeroEncumbrances -

Returns:

the number of qualifying open encumbrances

See Also:

org.kuali.kfs.gl.service.EncumbranceService#getOpenEncumbranceCount(java.util.Map)

hasSummarizedOpenEncumbranceRecords

public boolean hasSummarizedOpenEncumbranceRecords(Map fieldValues,
                                          boolean includeZeroEncumbrances)

Finds open encumbrances that have the keys given in the map summarized by balance type codes where the sum(ACCOUNT_LINE_ENCUMBRANCE_AMOUNT - sum(ACCOUNT_LINE_ENCUMBRANCE_CLOSED_AMOUNT ) != 0 and returns true if there are any results.

Specified by:

hasSummarizedOpenEncumbranceRecords in interface EncumbranceService

Parameters:

fieldValues - the input fields and values

includeZeroEncumbrances -

Returns:

true if there any open encumbrances when summarized by balance type

See Also:

org.kuali.kfs.gl.dataaccess.EncumbranceDao#hasSummarizedOpenEncumbranceRecords(java.util.Map)