org.kuali.ole.gl.dataaccess

Interface BalanceDao

All Known Implementing Classes:

BalanceDaoOjb

public interface BalanceDao

The DAO interface that declares methods needed to query the database about balances

Method Summary

Methods

Modifier and Type	Method and Description
int	countBalancesForFiscalYear(Integer year) This method returns the total count of balances for a fiscal year
Iterator<Balance>	findAccountBalances(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber) Returns the balance entries for the given year, chart, and account.
Iterator<Balance>	findAccountBalances(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String sfCode) Returns the balance entries for the given year, chart, and account.
Iterator	findBalance(Map fieldValues, boolean isConsolidated, Collection<String> encumbranceBalanceTypes) This method finds the records of balance entries according to input fields and values
Iterator	findBalances(Account account, Integer fiscalYear, Collection includedObjectCodes, Collection excludedObjectCodes, Collection objectTypeCodes, Collection balanceTypeCodes) Based on specific query types, return an Iterator of balance records
Iterator<Balance>	findBalancesForFiscalYear(Integer year) Returns all of the balances of a given fiscal year
Iterator<Balance>	findCumulativeBalancesToForwardForFiscalYear(Integer year, Collection<String> cumulativeForwardBalanceObjectTypes, Collection<String> contractsAndGrantsDenotingValues, Collection<String> subFundGroupsForCumulativeBalanceForwardingArray, Collection<String> cumulativeBalanceForwardBalanceTypesArray, boolean fundGroupDenotesCGInd) Returns the C&G balances specifically to be forwarded to the next fiscal year, based on the "cumulative" rule
Iterator<Balance>	findGeneralBalancesToForwardForFiscalYear(Integer year, Collection<String> generalForwardBalanceObjectTypes, Collection<String> generalBalanceForwardBalanceTypesArray) Returns the balances specifically to be forwarded to the next fiscal year, based on the "general" rule
Iterator<Balance>	findNominalActivityBalancesForFiscalYear(Integer year, Collection<String> nominalActivityObjectTypeCodes, SystemOptions currentYearOptions) This method returns all of the balances specifically for the nominal activity closing job
Iterator<Balance>	findOrganizationReversionBalancesForFiscalYear(Integer year, boolean endOfYear, SystemOptions options, List<ParameterEvaluator> parameterEvaluators) Returns the balances that would specifically be picked up by the Organization Reversion year end process
Balance	getBalanceByTransaction(Transaction t) Given a transaction, finds the balance record it would affect
Iterator	getConsolidatedBalanceRecordCount(Map fieldValues, Collection<String> encumbranceBalanceTypes) This method gets the size collection of balance entry groups according to input fields and values if the entries are required to be consolidated
int	getConsolidatedCashBalanceRecordCount(Map fieldValues, Collection<String> encumbranceBalanceTypes) This method gets the size collection of cash balance entry groups according to input fields and values if the entries are required to be consolidated
Balance	getCurrentBudgetForObjectCode(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String objectCode) Returns the CB (current budget) record for the given year, chart, account, and object code if one is found.
Integer	getDetailedCashBalanceRecordCount(Map fieldValues, Collection<String> encumbranceBalanceTypes) This method gets the size collection of cash balance entries or entry groups according to input fields and values
Iterator<Object[]>	getGlSummary(int universityFiscalYear, Collection<String> balanceTypeCodes) Get the GL Summary data
Iterator<Balance>	lookupCashBalance(Map fieldValues, boolean isConsolidated, Collection<String> encumbranceBalanceTypes) This method finds the cash balance entries according to input fields and values.
void	purgeYearByChart(String chart, int year) Purge the sufficient funds balance table by year/chart

Method Detail

getGlSummary

Iterator<Object[]> getGlSummary(int universityFiscalYear,
                              Collection<String> balanceTypeCodes)

Get the GL Summary data

Parameters:

universityFiscalYear - the fiscal year of balances to search for

balanceTypeCodes - a list of balance type codes of balances to search for

Returns:

iterator of reported on java.lang.Object arrays with the report data

getBalanceByTransaction

Balance getBalanceByTransaction(Transaction t)

Given a transaction, finds the balance record it would affect

Parameters:

t - a transaction

Returns:

the balance record it would affect

findBalances

Iterator findBalances(Account account,
                    Integer fiscalYear,
                    Collection includedObjectCodes,
                    Collection excludedObjectCodes,
                    Collection objectTypeCodes,
                    Collection balanceTypeCodes)

Based on specific query types, return an Iterator of balance records

Parameters:

account - the account of balances to find

fiscalYear - the fiscal year of balances to find

includedObjectCodes - a Collection of object codes found balances should have one of

excludedObjectCodes - a Collection of object codes found balances should not have one of

objectTypeCodes - a Collection of object type codes found balances should have one of

balanceTypeCodes - a Collection of balance type codes found balances should have one of

Returns:

an Iterator of Balances

lookupCashBalance

Iterator<Balance> lookupCashBalance(Map fieldValues,
                                  boolean isConsolidated,
                                  Collection<String> encumbranceBalanceTypes)

This method finds the cash balance entries according to input fields and values. The results will be limited to the system lookup results limit.

Parameters:

fieldValues - the input fields and values

isConsolidated - consolidation option is applied or not

encumbranceBalanceTypes - a list of encumbrance Balance Types

Returns:

the records of cash balance entries

getDetailedCashBalanceRecordCount

Integer getDetailedCashBalanceRecordCount(Map fieldValues,
                                        Collection<String> encumbranceBalanceTypes)

This method gets the size collection of cash balance entries or entry groups according to input fields and values

Parameters:

fieldValues - the input fields and values

isConsolidated - consolidation option is applied or not

encumbranceBalanceTypes - a list of encumbrance balance types

Returns:

the size collection of cash balance entry groups

getConsolidatedCashBalanceRecordCount

int getConsolidatedCashBalanceRecordCount(Map fieldValues,
                                        Collection<String> encumbranceBalanceTypes)

This method gets the size collection of cash balance entry groups according to input fields and values if the entries are required to be consolidated

Parameters:

fieldValues - the input fields and values

encumbranceBalanceTypes - a list of encumbrance balance types

Returns:

the size collection of cash balance entry groups

findBalance

Iterator findBalance(Map fieldValues,
                   boolean isConsolidated,
                   Collection<String> encumbranceBalanceTypes)

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

Parameters:

fieldValues - the input fields and values

isConsolidated - consolidation option is applied or not

encumbranceBalanceTypes - a list of encumbrance balance types

Returns:

the records of balance entries

getConsolidatedBalanceRecordCount

Iterator getConsolidatedBalanceRecordCount(Map fieldValues,
                                         Collection<String> encumbranceBalanceTypes)

This method gets the size collection of balance entry groups according to input fields and values if the entries are required to be consolidated

Parameters:

fieldValues - the input fields and values

encumbranceBalanceTypes - a list of encumbrance balance types

Returns:

the size collection of balance entry groups

findAccountBalances

Iterator<Balance> findAccountBalances(Integer universityFiscalYear,
                                    String chartOfAccountsCode,
                                    String accountNumber,
                                    String sfCode)

Returns the balance entries for the given year, chart, and account.

Parameters:

universityFiscalYear - the unversity fiscal year of balances to return

chartOfAccountsCode - the chart of accounts code of balances to return

accountNumber - the account number of balances to return

sfCode - Sufficient Funds Code (used to determine sorting)

Returns:

balance entries matching above

findAccountBalances

Iterator<Balance> findAccountBalances(Integer universityFiscalYear,
                                    String chartOfAccountsCode,
                                    String accountNumber)

Returns the balance entries for the given year, chart, and account.

Parameters:

universityFiscalYear - the fiscal year of balances to return

chartOfAccountsCode - the chart of accounts code of balances to return

accountNumber - the account number of balances to return

Returns:

balance entries matching above sorted by object code

getCurrentBudgetForObjectCode

Balance getCurrentBudgetForObjectCode(Integer universityFiscalYear,
                                    String chartOfAccountsCode,
                                    String accountNumber,
                                    String objectCode)

Returns the CB (current budget) record for the given year, chart, account, and object code if one is found.

Parameters:

universityFiscalYear - the fiscal year of the CB balance to return

chartOfAccountsCode - the chart of the accounts code of the CB balanes to return

accountNumber - the account number of the CB balance to return

objectCode - the object code of the CB balance to return

Returns:

the CB Balance record

purgeYearByChart

void purgeYearByChart(String chart,
                    int year)

Purge the sufficient funds balance table by year/chart

Parameters:

chart - the chart of balances to purge

year - the university fiscal year of balances to purge

findBalancesForFiscalYear

Iterator<Balance> findBalancesForFiscalYear(Integer year)

Returns all of the balances of a given fiscal year

Parameters:

year - the university fiscal year of balances to return

Returns:

an iterator over all balances for a given fiscal year

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,
                                                         Collection<String> nominalActivityObjectTypeCodes,
                                                         SystemOptions currentYearOptions)

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

Parameters:

year - year to find balances for

nominalActivityObjectTypeCodes - a List of nominal activity object type codes

currentYearOptions - current year options

Returns:

an Iterator of nominal activity balances

findGeneralBalancesToForwardForFiscalYear

Iterator<Balance> findGeneralBalancesToForwardForFiscalYear(Integer year,
                                                          Collection<String> generalForwardBalanceObjectTypes,
                                                          Collection<String> generalBalanceForwardBalanceTypesArray)

Returns the balances specifically to be forwarded to the next fiscal year, based on the "general" rule

Parameters:

year - the fiscal year to find balances for

generalForwardBalanceObjectTypes - a List of general Forward Balance Object Types

generalBalanceForwardBalanceTypesArray - an array of general Balance Forward Balance Types

Returns:

an Iterator full of Balances

findCumulativeBalancesToForwardForFiscalYear

Iterator<Balance> findCumulativeBalancesToForwardForFiscalYear(Integer year,
                                                             Collection<String> cumulativeForwardBalanceObjectTypes,
                                                             Collection<String> contractsAndGrantsDenotingValues,
                                                             Collection<String> subFundGroupsForCumulativeBalanceForwardingArray,
                                                             Collection<String> cumulativeBalanceForwardBalanceTypesArray,
                                                             boolean fundGroupDenotesCGInd)

Returns the C&G balances specifically to be forwarded to the next fiscal year, based on the "cumulative" rule

Parameters:

year - the fiscal year to find balances for

cumulativeForwardBalanceObjectTypes - a List of cumulative Forward Balance Object Types

contractsAndGrantsDenotingValues - a List of contracts And Grants Denoting Values

subFundGroupsForCumulativeBalanceForwardingArray - an array of sub Fund Groups For Cumulative Balance Forwarding

cumulativeBalanceForwardBalanceTypesArray - an array of cumulative Balance Forward Balance Types

Returns:

and Iterator chuck full of Balances

findOrganizationReversionBalancesForFiscalYear

Iterator<Balance> findOrganizationReversionBalancesForFiscalYear(Integer year,
                                                               boolean endOfYear,
                                                               SystemOptions options,
                                                               List<ParameterEvaluator> parameterEvaluators)

Returns the balances that would specifically be picked up by the Organization Reversion year end process

Parameters:

year - the year to find balances for

endOfYear -

options -

parameterEvaluators - a list of parameter evaluators

Returns:

an iterator of the balances to process