org.kuali.kfs.gl.service
Interface AccountBalanceService

All Known Implementing Classes:

AccountBalanceServiceImpl

public interface AccountBalanceService

This interface delcares methods useful for dealing with AccountBalance objects.

Field Summary

static int	PENDING_ALL
static int	PENDING_APPROVED
static int	PENDING_NONE

Method Summary

List	findAccountBalanceByConsolidation(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String subAccountNumber, boolean isCostShareExcluded, boolean isConsolidated, int pendingEntryCode) This method finds the available account balances according to input fields and values
List	findAccountBalanceByLevel(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String subAccountNumber, String financialConsolidationObjectCode, boolean isCostShareExcluded, boolean isConsolidated, int pendingEntryCode) This method finds the available account balances according to input fields and values
List	findAccountBalanceByObject(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String subAccountNumber, String financialObjectLevelCode, String financialReportingSortCode, boolean isCostShareExcluded, boolean isConsolidated, int pendingEntryCode) This method finds the available account balances according to input fields and values
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	getAvailableAccountBalanceCount(Map fieldValues, boolean isConsolidated) This method gets the number of the available account balances according to input fields and values
void	purgeYearByChart(String chartOfAccountsCode, int year) Purge an entire fiscal year for a single chart.
void	save(AccountBalance ab) Save an account balance

Field Detail

PENDING_NONE

static final int PENDING_NONE

See Also:

Constant Field Values

PENDING_APPROVED

static final int PENDING_APPROVED

See Also:

Constant Field Values

PENDING_ALL

static final int PENDING_ALL

See Also:

Constant Field Values

Method Detail

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

getAvailableAccountBalanceCount

Integer getAvailableAccountBalanceCount(Map fieldValues,
                                        boolean isConsolidated)

This method gets the number of the available account balances according to input fields and values

Parameters:

fieldValues - the input fields and values

isConsolidated - determine whether the search results are consolidated

Returns:

the number of the available account balances

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

isConsolidated - determine whether the search results are consolidated

Returns:

a collection of account balance entries

findAccountBalanceByConsolidation

List findAccountBalanceByConsolidation(Integer universityFiscalYear,
                                       String chartOfAccountsCode,
                                       String accountNumber,
                                       String subAccountNumber,
                                       boolean isCostShareExcluded,
                                       boolean isConsolidated,
                                       int pendingEntryCode)

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

Parameters:

universityFiscalYear - the fiscal year account to find account balances for

chartOfAccountsCode - the chart of accounts code to find account balances for

accountNumber - the account number to find account balances for

subAccountNumber - the sub account number to find account balances for

isCostShareExcluded - should account balances found have cost share information excluded?

isConsolidated - should account balances found be consolidated?

pendingEntryCode - should pending entries be included in the query?

Returns:

a List of qualifying account balance records

findAccountBalanceByLevel

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

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

Parameters:

universityFiscalYear - the fiscal year account to find account balances for

chartOfAccountsCode - the chart of accounts code to find account balances for

accountNumber - the account number to find account balances for

subAccountNumber - the sub account number to find account balances for

financialConsolidationCode - the consolidation code to find account balances for

isCostShareExcluded - should account balances found have cost share information excluded?

isConsolidated - should account balances found be consolidated?

pendingEntryCode - should pending entries be included in the query?

Returns:

a List of qualifying account balance records

findAccountBalanceByObject

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

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

Parameters:

universityFiscalYear - the fiscal year account to find account balances for

chartOfAccountsCode - the chart of accounts code to find account balances for

accountNumber - the account number to find account balances for

subAccountNumber - the sub account number to find account balances for

financialObjectLevelCode - the financial object level code to find account balances for

financialReportingSortCode - the reporting sort code to sort account balances by

isCostShareExcluded - should account balances found have cost share information excluded?

isConsolidated - should account balances found be consolidated?

pendingEntryCode - should pending entries be included in the query?

Returns:

a List of qualifying account balance records

save

void save(AccountBalance ab)

Save an account balance

Parameters:

ab - account balance record to save

purgeYearByChart

void purgeYearByChart(String chartOfAccountsCode,
                      int year)

Purge an entire fiscal year for a single chart.

Parameters:

chartOfAccountsCode - the chart of accounts to purge account balance records from

year - the fiscal year to purge account balance records of