org.kuali.kfs.module.ld.service
Interface LaborLedgerBalanceService

All Known Implementing Classes:

LaborLedgerBalanceServiceImpl

public interface LaborLedgerBalanceService

Method Summary

LedgerBalance	addLedgerBalance(Collection<LedgerBalance> ledgerBalanceCollection, LaborTransaction transaction) convert the given transaction information into a ledger balance and add it into the given ledger balance collection with
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 gets the size 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>	findEmployeeFunding(Map fieldValues, boolean isConsolidated) find the funding by employee
List<EmployeeFunding>	findEmployeeFundingWithCSFTracker(Map fieldValues, boolean isConsolidated) find the employee funding with the corresponding CSF trakers
<T extends LedgerBalance> T	findLedgerBalance(Collection<T> ledgerBalanceCollection, LaborTransaction transaction) find a ledger balance from the given ledger balance collection with the given transaction information
<T extends LedgerBalance> T	findLedgerBalance(Collection<T> ledgerBalanceCollection, LaborTransaction transaction, List<String> keyList) find a ledger balance from the given ledger balance collection with the given transaction information
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
Integer	getBalanceRecordCount(Map fieldValues, boolean isConsolidated) This method finds the summary records of balance entries according to input fields and values
void	save(LedgerBalance ledgerBalance) save the given ledger balance into the underlying data store
<T extends LedgerBalance> void	updateLedgerBalance(T ledgerBalance, LaborTransaction transaction) update the given ledger balance with the given transaction information

Method Detail

findBalancesForFiscalYear

Iterator<LedgerBalance> findBalancesForFiscalYear(Integer fiscalYear)

Parameters:

fiscalYear - the given fiscal year

Returns:

an Iterator over all balances for a given year

findBalancesForFiscalYear

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

Parameters:

fiscalYear - the given fiscal year

fieldValues - the input fields and values

Returns:

an Iterator over all balances for a given year and search criteria

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

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

findLedgerBalance

<T extends LedgerBalance> T findLedgerBalance(Collection<T> ledgerBalanceCollection,
                                              LaborTransaction transaction,
                                              List<String> keyList)

find a ledger balance from the given ledger balance collection with the given transaction information

Parameters:

ledgerBalanceCollection - the given ledger balance collection

transaction - the given transaction information

keyList - the given list of keys that need to be compared

Returns:

a matching ledger balance from the given ledger balance

findLedgerBalance

<T extends LedgerBalance> T findLedgerBalance(Collection<T> ledgerBalanceCollection,
                                              LaborTransaction transaction)

find a ledger balance from the given ledger balance collection with the given transaction information

Parameters:

ledgerBalanceCollection - the given ledger balance collection

transaction - the given transaction information

Returns:

a matching ledger balance from the given ledger balance

addLedgerBalance

LedgerBalance addLedgerBalance(Collection<LedgerBalance> ledgerBalanceCollection,
                               LaborTransaction transaction)

convert the given transaction information into a ledger balance and add it into the given ledger balance collection with

Parameters:

ledgerBalanceCollection - the given ledger balance collection

transaction - the given transaction information

Returns:

the ledger balance that has been added; otherwise, null;

updateLedgerBalance

<T extends LedgerBalance> void updateLedgerBalance(T ledgerBalance,
                                                   LaborTransaction transaction)

update the given ledger balance with the given transaction information

Parameters:

ledgerBalance - the given ledger balance

transaction - the given transaction information

findEmployeeFunding

List<EmployeeFunding> findEmployeeFunding(Map fieldValues,
                                          boolean isConsolidated)

find the funding by employee

Parameters:

fieldValues - the given field values

Returns:

the funding by employee

findEmployeeFundingWithCSFTracker

List<EmployeeFunding> findEmployeeFundingWithCSFTracker(Map fieldValues,
                                                        boolean isConsolidated)

find the employee funding with the corresponding CSF trakers

Parameters:

fieldValues - the given field values

Returns:

the employee funding with the corresponding CSF trakers

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

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