org.kuali.kfs.module.ld.dataaccess
Interface LaborLedgerBalanceDao

All Known Implementing Classes:

LaborLedgerBalanceDaoOjb

public interface LaborLedgerBalanceDao

This is the data access object for ledger balance.

See Also:

LedgerBalance

Method Summary

void	deleteLedgerBalancesPriorToYear(Integer fiscalYear, String chartOfAccountsCode) delete the ledger balance records that were posted prior to the given fiscal year
List<List<String>>	findAccountsInFundGroups(Integer fiscalYear, Map<String,String> fieldValues, List<String> subFundGroupCodes, List<String> fundGroupCodes) find the accounts (chart of accounts code + account number) in the given fund groups
Iterator	findBalance(Map fieldValues, boolean isConsolidated) This method finds the records of balance entries according to input fields and values
Iterator<LedgerBalance>	findBalancesForFiscalYear(Integer fiscalYear)
Iterator<LedgerBalance>	findBalancesForFiscalYear(Integer fiscalYear, Map<String,String> fieldValues)
Iterator<LedgerBalanceForYearEndBalanceForward>	findBalancesForFiscalYear(Integer fiscalYear, Map<String,String> fieldValues, List<String> subFundGroupCodes, List<String> fundGroupCodes)
List<LaborBalanceSummary>	findBalanceSummary(Integer fiscalYear, Collection<String> balanceTypes) find the summary of the ledger balances for the given fiscal year and balance types
List<EmployeeFunding>	findCurrentEmployeeFunds(Map fieldValues) retrieve the current funds according to the given field values
List<LedgerBalance>	findCurrentFunds(Map fieldValues) retrieve the current funds according to the given field values
List<EmployeeFunding>	findEncumbranceEmployeeFunds(Map fieldValues) retrieve the encumbrance funds according to the given field values
List<LedgerBalance>	findEncumbranceFunds(Map fieldValues) retrieve the encumbrance funds according to the given field values
Collection<LedgerBalance>	findLedgerBalances(Map<String,List<String>> fieldValues, Map<String,List<String>> excludedFieldValues, Set<Integer> fiscalYears, List<String> balanceTypeList, List<String> positionObjectGroupCodes) find all ledger balances matching the given criteria within the given fiscal years
Iterator	getConsolidatedBalanceRecordCount(Map fieldValues) This method gets the size collection of balance entry groups according to input fields and values if the entries are required to be consolidated
void	save(LedgerBalance ledgerBalance) save the given ledger balance into the underlying data store

Method Detail

findBalance

Iterator findBalance(Map fieldValues,
                     boolean isConsolidated)

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

Returns:

the records of balance entries

getConsolidatedBalanceRecordCount

Iterator getConsolidatedBalanceRecordCount(Map fieldValues)

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

Returns:

the size collection of balance entry groups

findBalancesForFiscalYear

Iterator<LedgerBalance> findBalancesForFiscalYear(Integer fiscalYear)

Parameters:

fiscalYear - the given fiscal year

Returns:

an iterator over all balances for a given fiscal year

findCurrentFunds

List<LedgerBalance> findCurrentFunds(Map fieldValues)

retrieve the current funds according to the given field values

Parameters:

fieldValues - the given field values

Returns:

the current funds according to the given field values

findEncumbranceFunds

List<LedgerBalance> findEncumbranceFunds(Map fieldValues)

retrieve the encumbrance funds according to the given field values

Parameters:

fieldValues - the given field values

Returns:

the encumbrance funds according to the given field values

findCurrentEmployeeFunds

List<EmployeeFunding> findCurrentEmployeeFunds(Map fieldValues)

retrieve the current funds according to the given field values

Parameters:

fieldValues - the given field values

Returns:

the current funds according to the given field values

findEncumbranceEmployeeFunds

List<EmployeeFunding> findEncumbranceEmployeeFunds(Map fieldValues)

retrieve the encumbrance funds according to the given field values

Parameters:

fieldValues - the given field values

Returns:

the encumbrance funds according to the given field values

findBalanceSummary

List<LaborBalanceSummary> findBalanceSummary(Integer fiscalYear,
                                             Collection<String> balanceTypes)

find the summary of the ledger balances for the given fiscal year and balance types

Parameters:

fiscalYear - the given fiscal year

balanceTypes - the given balance type codes

Returns:

the ledger balances for the given fiscal year and balance types

save

void save(LedgerBalance ledgerBalance)

save the given ledger balance into the underlying data store

Parameters:

ledgerBalance - the given ledger balance

findBalancesForFiscalYear

Iterator<LedgerBalance> findBalancesForFiscalYear(Integer fiscalYear,
                                                  Map<String,String> fieldValues)

Parameters:

fiscalYear - the given fiscal year

fieldValues - the given field values

Returns:

an iterator over all balances for a given fiscal year

findBalancesForFiscalYear

Iterator<LedgerBalanceForYearEndBalanceForward> findBalancesForFiscalYear(Integer fiscalYear,
                                                                          Map<String,String> fieldValues,
                                                                          List<String> subFundGroupCodes,
                                                                          List<String> fundGroupCodes)

Parameters:

fiscalYear - the given fiscal year

fieldValues - the input fields and values

subFundGroupCodes - the given list of qualified sub fund group codes

fundGroupCodes - the given list of qualified group codes

Returns:

an Iterator over all balances for a given year and search criteria that include the accounts of balances must belong to the given sub fund group or fund group

findAccountsInFundGroups

List<List<String>> findAccountsInFundGroups(Integer fiscalYear,
                                            Map<String,String> fieldValues,
                                            List<String> subFundGroupCodes,
                                            List<String> fundGroupCodes)

find the accounts (chart of accounts code + account number) in the given fund groups

Parameters:

fiscalYear - the given fiscal year

fieldValues - the input fields and values

subFundGroupCodes - the given list of qualified sub fund group codes

fundGroupCodes - the given list of qualified group codes

Returns:

the accounts (chart of accounts code + account number) in the given fund groups

findLedgerBalances

Collection<LedgerBalance> findLedgerBalances(Map<String,List<String>> fieldValues,
                                             Map<String,List<String>> excludedFieldValues,
                                             Set<Integer> fiscalYears,
                                             List<String> balanceTypeList,
                                             List<String> positionObjectGroupCodes)

find all ledger balances matching the given criteria within the given fiscal years

Parameters:

fieldValues - the given field values

excludedFieldValues - the given field values that must not be matched

fiscalYears - the given fiscal years

balanceTypeList - the given balance type code list

positionObjectGroupCodes - the specified position obejct group codes

Returns:

all ledger balances matching the given criteria within the given fiscal years

deleteLedgerBalancesPriorToYear

void deleteLedgerBalancesPriorToYear(Integer fiscalYear,
                                     String chartOfAccountsCode)

delete the ledger balance records that were posted prior to the given fiscal year

Parameters:

fiscalYear - the given fiscal year

chartOfAccountsCode - the given chart of account code