org.kuali.kfs.gl.service
Interface BalanceService

All Known Implementing Classes:

BalanceServiceImpl

public interface BalanceService

An interface which declares methods needed for using Balance

Method Summary

boolean	beginningBalanceLoaded(Account account) This method...
int	countBalancesForFiscalYear(Integer year) This method returns the total count of balances for a fiscal year
Iterator	findBalance(Map fieldValues, boolean isConsolidated) This method gets the size of balance entries according to input fields and values
Iterator<Balance>	findBalancesForFiscalYear(Integer fiscalYear) Returns all of the balances for a given fiscal year.
Iterator	findCashBalance(Map fieldValues, boolean isConsolidated) This method finds the summary records of balance entries according to input fields an values
Iterator<Balance>	findCumulativeBalancesToForwardForFiscalYear(Integer year) Returns all the balances to be forwarded for the "cumulative" rule
Iterator<Balance>	findGeneralBalancesToForwardForFiscalYear(Integer year) Returns all the balances specifically to be processed by the balance forwards job for the "general" rule
Iterator<Balance>	findNominalActivityBalancesForFiscalYear(Integer year) This method returns all of the balances specifically for the nominal activity closing job
Iterator<Balance>	findOrganizationReversionBalancesForFiscalYear(Integer year, boolean endOfYear) Returns all of the balances to be forwarded for the organization reversion process
boolean	fundBalanceWillNetToZero(Account account) This method...
Integer	getBalanceRecordCount(Map fieldValues, boolean isConsolidated) This method finds the summary records of balance entries according to input fields and values
Integer	getCashBalanceRecordCount(Map fieldValues, boolean isConsolidated) This method gets the size of cash balance entries according to input fields and values
List<GlSummary>	getGlSummary(int universityFiscalYear, List<String> balanceTypeCodes) Get the GL Balance summary for the GL Summary report
boolean	hasAssetLiabilityFundBalanceBalances(Account account) This method...
boolean	hasAssetLiabilityOrFundBalance(Account account) This method...
boolean	hasEncumbrancesOrBaseBudgets(Account account) This method...
void	purgeYearByChart(String chart, int year) Purge the sufficient funds balance table by year/chart
void	save(Balance b) Save.

Method Detail

save

void save(Balance b)

Save. Like. OK. You know. Save a balance? You know? That's what this method should do. Yeah. It should save a balance. In the DB and stuff.

Parameters:

b - the balance to, like, totally save

hasAssetLiabilityFundBalanceBalances

boolean hasAssetLiabilityFundBalanceBalances(Account account)

This method...

Parameters:

account -

Returns:

fundBalanceWillNetToZero

boolean fundBalanceWillNetToZero(Account account)

This method...

Parameters:

account -

Returns:

hasEncumbrancesOrBaseBudgets

boolean hasEncumbrancesOrBaseBudgets(Account account)

This method...

Parameters:

account -

Returns:

beginningBalanceLoaded

boolean beginningBalanceLoaded(Account account)

This method...

Parameters:

account -

Returns:

hasAssetLiabilityOrFundBalance

boolean hasAssetLiabilityOrFundBalance(Account account)

This method...

Parameters:

account -

Returns:

findBalancesForFiscalYear

Iterator<Balance> findBalancesForFiscalYear(Integer fiscalYear)

Returns all of the balances for a given fiscal year.

Parameters:

fiscalYear - the fiscal year to find balances for

Returns:

an Iterator over all balances for a given year

findCashBalance

Iterator findCashBalance(Map fieldValues,
                         boolean isConsolidated)

This method finds the summary records of balance entries according to input fields an values

Parameters:

fieldValues - the input fields an values

isConsolidated - consolidation option is applied or not

Returns:

the summary records of balance entries

getCashBalanceRecordCount

Integer getCashBalanceRecordCount(Map fieldValues,
                                  boolean isConsolidated)

This method gets the size of cash balance entries according to input fields and values

Parameters:

fieldValues - the input fields and values

isConsolidated - consolidation option is applied or not

Returns:

the count of cash balance entries

findBalance

Iterator findBalance(Map fieldValues,
                     boolean isConsolidated)

This method gets the size of balance entries according to input fields and values

Parameters:

fieldValues - the input fields and values

isConsolidated - consolidation option is applied or not

Returns:

the size of balance entries

getBalanceRecordCount

Integer getBalanceRecordCount(Map fieldValues,
                              boolean isConsolidated)

This method finds the summary records of balance entries according to input fields and values

Parameters:

fieldValues - the input fields and values

isConsolidated - consolidation option is applied or not

Returns:

the summary records of balance entries

purgeYearByChart

void purgeYearByChart(String chart,
                      int year)

Purge the sufficient funds balance table by year/chart

Parameters:

chart - the chart purged balances should have

year - the fiscal year purged balances should have

getGlSummary

List<GlSummary> getGlSummary(int universityFiscalYear,
                             List<String> balanceTypeCodes)

Get the GL Balance summary for the GL Summary report

Parameters:

universityFiscalYear -

balanceTypeCodes -

Returns:

a list of summarized GL balances

countBalancesForFiscalYear

int countBalancesForFiscalYear(Integer year)

This method returns the total count of balances for a fiscal year

Parameters:

year - fiscal year to check

Returns:

the count of balances

findNominalActivityBalancesForFiscalYear

Iterator<Balance> findNominalActivityBalancesForFiscalYear(Integer year)

This method returns all of the balances specifically for the nominal activity closing job

Parameters:

year - year to find balances for

Returns:

an Iterator of nominal activity balances

findGeneralBalancesToForwardForFiscalYear

Iterator<Balance> findGeneralBalancesToForwardForFiscalYear(Integer year)

Returns all the balances specifically to be processed by the balance forwards job for the "general" rule

Parameters:

year - the fiscal year to find balances for

Returns:

an Iterator of balances to process for the general balance forward process

findCumulativeBalancesToForwardForFiscalYear

Iterator<Balance> findCumulativeBalancesToForwardForFiscalYear(Integer year)

Returns all the balances to be forwarded for the "cumulative" rule

Parameters:

year - the fiscal year to find balances for

Returns:

an Iterator of balances to process for the cumulative/active balance forward process

findOrganizationReversionBalancesForFiscalYear

Iterator<Balance> findOrganizationReversionBalancesForFiscalYear(Integer year,
                                                                 boolean endOfYear)

Returns all of the balances to be forwarded for the organization reversion process

Parameters:

year - the year of balances to find

endOfYear - whether the organization reversion process is running end of year (before the fiscal year change over) or beginning of year (after the fiscal year change over)

Returns:

an iterator of balances to put through the strenuous organization reversion process