org.kuali.ole.sys.dataaccess

Interface GeneralLedgerPendingEntryDao

All Known Implementing Classes:

GeneralLedgerPendingEntryDaoOjb

public interface GeneralLedgerPendingEntryDao

This interface defines basic methods that GeneralLedgerPendingEntry Dao's must provide

Method Summary

Methods

Modifier and Type	Method and Description
int	countPendingLedgerEntries(Account account) This method counts all approved pending ledger entries by account
void	delete(String documentHeaderId) Delete all pending entries for a given document
void	deleteByFinancialDocumentApprovedCode(String financialDocumentApprovedCode) Delete all pending entries based on the document approved code
Iterator	findApprovedPendingLedgerEntries() This method retrieves all approved pending ledger entries
Collection	findPendingEntries(Map fieldValues, boolean isApproved, String currentFiscalPeriodCode, int currentFiscalYear, List<String> encumbranceBalanceTypes) Find Pending Entries
Iterator	findPendingLedgerEntries(Balance balance, boolean isApproved, boolean isConsolidated) This method retrieves all pending ledger entries for the given encumbrance
Iterator	findPendingLedgerEntries(Encumbrance encumbrance, boolean isApproved) This method retrieves all pending ledger entries for the given encumbrance
Iterator	findPendingLedgerEntriesForAccountBalance(Map fieldValues, boolean isApproved, String currentFiscalPeriodCode, int currentFiscalYear, List<String> encumbranceBalanceTypes) This method retrieves all pending ledger entries that may belong to the given account balance record in the future
Iterator	findPendingLedgerEntriesForBalance(Map fieldValues, boolean isApproved, String currentFiscalPeriodCode, int currentFY, List<String> encumbranceBalanceTypes) This method retrieves all pending ledger entries matching the given balance criteria
Iterator	findPendingLedgerEntriesForCashBalance(Map fieldValues, boolean isApproved, String currentFiscalPeriodCode, int currentFY, List<String> encumbranceBalanceTypes) This method retrieves all pending ledger entries matching the given cash balance criteria
Iterator	findPendingLedgerEntriesForEncumbrance(Map fieldValues, boolean isApproved, String currentFiscalPeriodCode, int currentFiscalYear, SystemOptions currentYearOptions, List<String> encumbranceBalanceTypes) This method retrieves all pending ledger entries that may belong to encumbrance table in the future
Iterator	findPendingLedgerEntriesForEntry(Map fieldValues, boolean isApproved, String currentFiscalPeriodCode, int currentFY, List<String> encumbranceBalanceTypes) This method retrieves all pending ledger entries matching the given entry criteria
Iterator	findPendingLedgerEntrySummaryForAccountBalance(Map fieldValues, boolean isApproved, String currentFiscalPeriodCode, int currentFiscalYear, List<String> encumbranceBalanceTypes) This method retrieves all pending ledger entries that may belong to the given account balance record in the future
org.kuali.rice.core.api.util.type.KualiDecimal	getTransactionSummary(Collection universityFiscalYears, String chartOfAccountsCode, String accountNumber, Collection objectCodes, Collection balanceTypeCodes, boolean isDebit) Get summary of amounts in the pending entry table
org.kuali.rice.core.api.util.type.KualiDecimal	getTransactionSummary(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, Collection objectTypeCodes, Collection balanceTypeCodes, String acctSufficientFundsFinObjCd, boolean isYearEnd) Get summary of amounts in the pending entry table
org.kuali.rice.core.api.util.type.KualiDecimal	getTransactionSummary(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, Collection objectTypeCodes, Collection balanceTypeCodes, String acctSufficientFundsFinObjCd, boolean isDebit, boolean isYearEnd) Get summary of amounts in the pending entry table

Method Detail

getTransactionSummary

org.kuali.rice.core.api.util.type.KualiDecimal getTransactionSummary(Collection universityFiscalYears,
                                                                   String chartOfAccountsCode,
                                                                   String accountNumber,
                                                                   Collection objectCodes,
                                                                   Collection balanceTypeCodes,
                                                                   boolean isDebit)

Get summary of amounts in the pending entry table

Parameters:

universityFiscalYear -

chartOfAccountsCode -

accountNumber -

objectCodes -

balanceTypeCodes -

isDebit -

Returns:

getTransactionSummary

org.kuali.rice.core.api.util.type.KualiDecimal getTransactionSummary(Integer universityFiscalYear,
                                                                   String chartOfAccountsCode,
                                                                   String accountNumber,
                                                                   Collection objectTypeCodes,
                                                                   Collection balanceTypeCodes,
                                                                   String acctSufficientFundsFinObjCd,
                                                                   boolean isDebit,
                                                                   boolean isYearEnd)

Get summary of amounts in the pending entry table

Parameters:

universityFiscalYear -

chartOfAccountsCode -

accountNumber -

objectTypeCodes -

balanceTypeCodes -

acctSufficientFundsFinObjCd -

isDebit -

isYearEnd -

Returns:

getTransactionSummary

org.kuali.rice.core.api.util.type.KualiDecimal getTransactionSummary(Integer universityFiscalYear,
                                                                   String chartOfAccountsCode,
                                                                   String accountNumber,
                                                                   Collection objectTypeCodes,
                                                                   Collection balanceTypeCodes,
                                                                   String acctSufficientFundsFinObjCd,
                                                                   boolean isYearEnd)

Get summary of amounts in the pending entry table

Parameters:

universityFiscalYear -

chartOfAccountsCode -

accountNumber -

objectTypeCodes -

balanceTypeCodes -

acctSufficientFundsFinObjCd -

isYearEnd -

Returns:

findPendingEntries

Collection findPendingEntries(Map fieldValues,
                            boolean isApproved,
                            String currentFiscalPeriodCode,
                            int currentFiscalYear,
                            List<String> encumbranceBalanceTypes)

Find Pending Entries

Parameters:

fieldValues -

isApproved -

currentFiscalPeriodCode -

currentFiscalYear -

encumbranceBalanceTypes - a list of encumbranceBalanceTypes for the given universityFiscalYear if this is passed in the fieldValues or the Current Year Encumbrance Balance Types if universityFiscalYear is not present

Returns:

delete

void delete(String documentHeaderId)

Delete all pending entries for a given document

Parameters:

documentHeaderId -

deleteByFinancialDocumentApprovedCode

void deleteByFinancialDocumentApprovedCode(String financialDocumentApprovedCode)

Delete all pending entries based on the document approved code

Parameters:

financialDocumentApprovedCode -

findApprovedPendingLedgerEntries

Iterator findApprovedPendingLedgerEntries()

This method retrieves all approved pending ledger entries

Returns:

all approved pending ledger entries

countPendingLedgerEntries

int countPendingLedgerEntries(Account account)

This method counts all approved pending ledger entries by account

Parameters:

account - the given account

Returns:

count of entries

findPendingLedgerEntries

Iterator findPendingLedgerEntries(Encumbrance encumbrance,
                                boolean isApproved)

This method retrieves all pending ledger entries for the given encumbrance

Parameters:

encumbrance - the encumbrance entry in the GL_Encumbrance_T table

isApproved - the flag that indicates whether the pending entries are approved or don't care

Returns:

all pending ledger entries of the given encumbrance

findPendingLedgerEntries

Iterator findPendingLedgerEntries(Balance balance,
                                boolean isApproved,
                                boolean isConsolidated)

This method retrieves all pending ledger entries for the given encumbrance

Parameters:

balance - the balance entry

isApproved - the flag that indicates whether the pending entries are approved or don't care

isConsolidated - consolidation option is applied or not

Returns:

all pending ledger entries of the given balance

findPendingLedgerEntriesForEntry

Iterator findPendingLedgerEntriesForEntry(Map fieldValues,
                                        boolean isApproved,
                                        String currentFiscalPeriodCode,
                                        int currentFY,
                                        List<String> encumbranceBalanceTypes)

This method retrieves all pending ledger entries matching the given entry criteria

Parameters:

isApproved - the flag that indicates whether the pending entries are approved or don't care

fieldValues - the input fields and values

currentFiscalPeriodCode - current fiscal year period code

currentFY - current fiscal year

encumbranceBalanceTypes - a list of encumbranceBalanceTypes

Returns:

all pending ledger entries matching the given balance criteria

findPendingLedgerEntriesForBalance

Iterator findPendingLedgerEntriesForBalance(Map fieldValues,
                                          boolean isApproved,
                                          String currentFiscalPeriodCode,
                                          int currentFY,
                                          List<String> encumbranceBalanceTypes)

This method retrieves all pending ledger entries matching the given balance criteria

Parameters:

isApproved - the flag that indicates whether the pending entries are approved or don't care

fieldValues - the input fields and values

currentFiscalPeriodCode - current fiscal year period code

currentFY - current fiscal year

encumbranceBalanceTypes - a list of encumbranceBalanceTypes

Returns:

all pending ledger entries matching the given balance criteria

findPendingLedgerEntriesForCashBalance

Iterator findPendingLedgerEntriesForCashBalance(Map fieldValues,
                                              boolean isApproved,
                                              String currentFiscalPeriodCode,
                                              int currentFY,
                                              List<String> encumbranceBalanceTypes)

This method retrieves all pending ledger entries matching the given cash balance criteria

Parameters:

isApproved - the flag that indicates whether the pending entries are approved or don't care

fieldValues - the input fields and values

currentFiscalPeriodCode - current fiscal year period code

currentFY - current fiscal year

encumbranceBalanceTypes - a list of encumbranceBalanceTypes for the given universityFiscalYear if this is passed in the fieldValues or the Current Year Encumbrance Balance Types if universityFiscalYear is not present

Returns:

all pending ledger entries matching the given cash balance criteria

findPendingLedgerEntriesForEncumbrance

Iterator findPendingLedgerEntriesForEncumbrance(Map fieldValues,
                                              boolean isApproved,
                                              String currentFiscalPeriodCode,
                                              int currentFiscalYear,
                                              SystemOptions currentYearOptions,
                                              List<String> encumbranceBalanceTypes)

This method retrieves all pending ledger entries that may belong to encumbrance table in the future

Parameters:

isApproved - the flag that indicates whether the pending entries are approved or don't care

fieldValues - the input fields and values

currentFiscalPeriodCode - current fiscal year period code

currentFY - current fiscal year

currentYearOptions - the current year system options

encumbranceBalanceTypes - a list of encumbranceBalanceTypes for the given universityFiscalYear if this is passed in the fieldValues or the Current Year Encumbrance Balance Types if universityFiscalYear is not present

Returns:

all pending ledger entries that may belong to encumbrance table

findPendingLedgerEntrySummaryForAccountBalance

Iterator findPendingLedgerEntrySummaryForAccountBalance(Map fieldValues,
                                                      boolean isApproved,
                                                      String currentFiscalPeriodCode,
                                                      int currentFiscalYear,
                                                      List<String> encumbranceBalanceTypes)

This method retrieves all pending ledger entries that may belong to the given account balance record in the future

Parameters:

fieldValues - the input fields and values

isApproved - the flag that indicates whether the pending entries are approved or don't care

currentFiscalPeriodCode - current fiscal year period code

currentFY - current fiscal year

encumbranceBalanceTypes - a list of encumbranceBalanceTypes for the given universityFiscalYear if this is passed in the fieldValues or the Current Year Encumbrance Balance Types if universityFiscalYear is not present

Returns:

all pending ledger entries that may belong to encumbrance table

findPendingLedgerEntriesForAccountBalance

Iterator findPendingLedgerEntriesForAccountBalance(Map fieldValues,
                                                 boolean isApproved,
                                                 String currentFiscalPeriodCode,
                                                 int currentFiscalYear,
                                                 List<String> encumbranceBalanceTypes)

This method retrieves all pending ledger entries that may belong to the given account balance record in the future

Parameters:

fieldValues - the input fields and values

isApproved - the flag that indicates whether the pending entries are approved or don't care

currentFiscalPeriodCode - current fiscal year period code

currentFY - current fiscal year

encumbranceBalanceTypes - a list of encumbranceBalanceTypes for the given universityFiscalYear if this is passed in the fieldValues or the Current Year Encumbrance Balance Types if universityFiscalYear is not present

Returns:

all pending ledger entries that may belong to encumbrance table