org.kuali.kfs.gl.dataaccess
Interface AccountBalanceDao

All Known Implementing Classes:

AccountBalanceDaoOjb

public interface AccountBalanceDao

An interface that declares methods needed for AccountBalances to interact with the database

Method Summary

List	findAccountBalanceByConsolidationByObjectTypes(String[] objectTypes, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, boolean isExcludeCostShare, boolean isConsolidated, int pendingEntriesCode) Get available balances by consolidation for specific object types
List	findAccountBalanceByLevel(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String financialConsolidationObjectCode, boolean isCostShareExcluded, boolean isConsolidated, int pendingEntryCode) Get available balances by level
List	findAccountBalanceByObject(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String financialObjectLevelCode, String financialReportingSortCode, boolean isCostShareExcluded, boolean isConsolidated, int pendingEntryCode) Get available balances by object
Iterator	findAvailableAccountBalance(Map fieldValues) This method finds the available account balances according to input fields and values
Iterator	findConsolidatedAvailableAccountBalance(Map fieldValues) This method finds the available account balances according to input fields and values
Integer	findCountGreaterOrEqualThan(Integer year)
AccountBalance	getByTransaction(Transaction t) Given a transaction, finds a matching account balance in the database
void	purgeYearByChart(String chartOfAccountscode, int year) Purge an entire fiscal year for a single chart.
void	save(AccountBalance ab) Saves an account balance to the database

Method Detail

getByTransaction

AccountBalance getByTransaction(Transaction t)

Given a transaction, finds a matching account balance in the database

Parameters:

t - a transaction to find an appropriate related account balance for

Returns:

an appropriate account balance

save

void save(AccountBalance ab)

Saves an account balance to the database

Parameters:

ab - an account balance to save

findConsolidatedAvailableAccountBalance

Iterator findConsolidatedAvailableAccountBalance(Map fieldValues)

This method finds the available account balances according to input fields and values

Parameters:

fieldValues - the input fields and values

Returns:

the summary records of account balance entries

findAvailableAccountBalance

Iterator findAvailableAccountBalance(Map fieldValues)

This method finds the available account balances according to input fields and values

Parameters:

fieldValues - the input fields and values

Returns:

account balance entries

findAccountBalanceByConsolidationByObjectTypes

List findAccountBalanceByConsolidationByObjectTypes(String[] objectTypes,
                                                    Integer universityFiscalYear,
                                                    String chartOfAccountsCode,
                                                    String accountNumber,
                                                    boolean isExcludeCostShare,
                                                    boolean isConsolidated,
                                                    int pendingEntriesCode)

Get available balances by consolidation for specific object types

Parameters:

objectTypes - the object types that reported account balances must have

universityFiscalYear - the university fiscal year of account balances to find

chartOfAccountsCode - the chart of accounts of account balances to find

accountNumber - the account number of account balances to find

isExcludeCostShare - whether cost share entries should be excluded from this inquiry

isConsolidated - whether the results of this should be consolidated or not

pendingEntriesCode - whether to include no pending entries, approved pending entries, or all pending entries

Returns:

a List of Maps with the appropriate query results

findAccountBalanceByLevel

List findAccountBalanceByLevel(Integer universityFiscalYear,
                               String chartOfAccountsCode,
                               String accountNumber,
                               String financialConsolidationObjectCode,
                               boolean isCostShareExcluded,
                               boolean isConsolidated,
                               int pendingEntryCode)

Get available balances by level

Parameters:

universityFiscalYear - the university fiscal year of account balances to find

chartOfAccountsCode - the chart of accounts of account balances to find

accountNumber - the account number of account balances to find

financialConsolidationObjectCode - the consolidation code of account balances to find

isCostShareExcluded - whether cost share entries should be excluded from this inquiry

isConsolidated - whether the results of this should be consolidated or not

Returns:

a List of Mapswith the appropriate query results

findAccountBalanceByObject

List findAccountBalanceByObject(Integer universityFiscalYear,
                                String chartOfAccountsCode,
                                String accountNumber,
                                String financialObjectLevelCode,
                                String financialReportingSortCode,
                                boolean isCostShareExcluded,
                                boolean isConsolidated,
                                int pendingEntryCode)

Get available balances by object

Parameters:

universityFiscalYear - the university fiscal year of account balances to find

chartOfAccountsCode - the chart of accounts of account balances to find

accountNumber - the account number of account balances to find

financialObjectLevelCode - the object level code of account balances to find

financialReportingSortCode -

isCostShareExcluded - whether cost share entries should be excluded from this inquiry

isConsolidated - whether the results of this should be consolidated or not

Returns:

a List of Maps with the appropriate query results

purgeYearByChart

void purgeYearByChart(String chartOfAccountscode,
                      int year)

Purge an entire fiscal year for a single chart.

Parameters:

chartOfAccountsCode - the chart of accounts code of account balances to purge

year - the fiscal year of account balances to purge

findCountGreaterOrEqualThan

Integer findCountGreaterOrEqualThan(Integer year)

Parameters:

year - the given university fiscal year

Returns:

count of rows for the given fiscal year