org.kuali.ole.sys.dataaccess.impl

Class GeneralLedgerPendingEntryDaoOjb

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport

org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb

org.kuali.ole.sys.dataaccess.impl.GeneralLedgerPendingEntryDaoOjb

All Implemented Interfaces:

GeneralLedgerPendingEntryDao, org.kuali.rice.core.framework.persistence.dao.PlatformAwareDao, org.springframework.beans.factory.InitializingBean

public class GeneralLedgerPendingEntryDaoOjb
extends org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb
implements GeneralLedgerPendingEntryDao

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ACCOUNT_NUMBER
protected static String	CHART_FINANCIAL_CASH_OBJECT_CODE
protected static String	CHART_OF_ACCOUNTS_CODE
protected static String	DOC_NUMBER
protected static String	FINANCIAL_DOCUMENT_APPROVED_CODE
protected static String	OBJECT_TYPE_FIN_OBJECT_TYPE_DEBITCREDIT_CD
protected static String	TRANSACTION_LEDGER_ENTRY_SEQUENCE_NUMBER

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

Constructors

Constructor and Description
GeneralLedgerPendingEntryDaoOjb()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addStatusCode(org.apache.ojb.broker.query.Criteria criteria, boolean isOnlyApproved) add the status code into the given criteria.
protected List	buildApprovalCodeList() build a status code list including the legal approval codes
protected List	buildAttributeList() This method builds the atrribute list used by balance searching
org.apache.ojb.broker.query.Criteria	buildCriteriaFromMap(Map fieldValues, Object businessObject, String currentFiscalPeriodCode, Integer currentFiscalYear, List<String> encumbranceBalanceTypes) This method builds an OJB query criteria based on the input field map
protected org.apache.ojb.broker.query.Criteria	buildCriteriaToExcludeFundBalance(SystemOptions currentYearOptions) This method creates Criteria that exclude the fund balance object type from the result.
protected List	buildGroupList() This method builds group by attribute list used by balance searching
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 currentFiscalYear, List<String> encumbranceBalanceType) 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
Class	getEntryClass() Gets the entryClass attribute.
protected Object	getEntryClassInstance()
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

Methods inherited from class org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb

getDbPlatform, setDbPlatform

Methods inherited from class org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport

checkDaoConfig, convertOjbAccessException, createPersistenceBrokerTemplate, getJcdAlias, getPersistenceBroker, getPersistenceBrokerTemplate, releasePersistenceBroker, setJcdAlias, setPersistenceBrokerTemplate

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TRANSACTION_LEDGER_ENTRY_SEQUENCE_NUMBER

protected static final String TRANSACTION_LEDGER_ENTRY_SEQUENCE_NUMBER

See Also:

Constant Field Values

FINANCIAL_DOCUMENT_APPROVED_CODE

protected static final String FINANCIAL_DOCUMENT_APPROVED_CODE

See Also:

Constant Field Values

ACCOUNT_NUMBER

protected static final String ACCOUNT_NUMBER

See Also:

Constant Field Values

DOC_NUMBER

protected static final String DOC_NUMBER

See Also:

Constant Field Values

CHART_OF_ACCOUNTS_CODE

protected static final String CHART_OF_ACCOUNTS_CODE

See Also:

Constant Field Values

CHART_FINANCIAL_CASH_OBJECT_CODE

protected static final String CHART_FINANCIAL_CASH_OBJECT_CODE

See Also:

Constant Field Values

OBJECT_TYPE_FIN_OBJECT_TYPE_DEBITCREDIT_CD

protected static final String OBJECT_TYPE_FIN_OBJECT_TYPE_DEBITCREDIT_CD

See Also:

Constant Field Values

Constructor Detail

GeneralLedgerPendingEntryDaoOjb

public GeneralLedgerPendingEntryDaoOjb()

Method Detail

getTransactionSummary

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

Description copied from interface: GeneralLedgerPendingEntryDao

Get summary of amounts in the pending entry table

Specified by:

getTransactionSummary in interface GeneralLedgerPendingEntryDao

Returns:

See Also:

org.kuali.module.gl.dao.GeneralLedgerPendingEntryDao#getTransactionSummary(java.lang.Integer, java.lang.String, java.lang.String, java.util.Collection, java.util.Collection, java.lang.String, boolean)

getTransactionSummary

public 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)

Description copied from interface: GeneralLedgerPendingEntryDao

Get summary of amounts in the pending entry table

Specified by:

getTransactionSummary in interface GeneralLedgerPendingEntryDao

Returns:

See Also:

org.kuali.module.gl.dao.GeneralLedgerPendingEntryDao#getTransactionSummary(java.lang.Integer, java.lang.String, java.lang.String, java.util.Collection, java.util.Collection, boolean, boolean)

getTransactionSummary

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

Description copied from interface: GeneralLedgerPendingEntryDao

Get summary of amounts in the pending entry table

Specified by:

getTransactionSummary in interface GeneralLedgerPendingEntryDao

Returns:

See Also:

org.kuali.module.gl.dao.GeneralLedgerPendingEntryDao#getTransactionSummary(java.util.Collection, java.lang.String, java.lang.String, java.util.Collection, java.util.Collection, boolean)

delete

public void delete(String documentHeaderId)

Description copied from interface: GeneralLedgerPendingEntryDao

Delete all pending entries for a given document

Specified by:

delete in interface GeneralLedgerPendingEntryDao

deleteByFinancialDocumentApprovedCode

public void deleteByFinancialDocumentApprovedCode(String financialDocumentApprovedCode)

Description copied from interface: GeneralLedgerPendingEntryDao

Delete all pending entries based on the document approved code

Specified by:

deleteByFinancialDocumentApprovedCode in interface GeneralLedgerPendingEntryDao

findApprovedPendingLedgerEntries

public Iterator findApprovedPendingLedgerEntries()

Description copied from interface: GeneralLedgerPendingEntryDao

This method retrieves all approved pending ledger entries

Specified by:

findApprovedPendingLedgerEntries in interface GeneralLedgerPendingEntryDao

Returns:

all approved pending ledger entries

See Also:

org.kuali.module.gl.dao.GeneralLedgerPendingEntryDao#findApprovedPendingLedgerEntries()

countPendingLedgerEntries

public int countPendingLedgerEntries(Account account)

Description copied from interface: GeneralLedgerPendingEntryDao

This method counts all approved pending ledger entries by account

Specified by:

countPendingLedgerEntries in interface GeneralLedgerPendingEntryDao

Parameters:

account - the given account

Returns:

count of entries

See Also:

org.kuali.module.gl.dao.GeneralLedgerPendingEntryDao#countPendingLedgerEntries(org.kuali.ole.coa.businessobject.Account)

findPendingLedgerEntries

public Iterator findPendingLedgerEntries(Encumbrance encumbrance,
                                boolean isApproved)

Description copied from interface: GeneralLedgerPendingEntryDao

This method retrieves all pending ledger entries for the given encumbrance

Specified by:

findPendingLedgerEntries in interface GeneralLedgerPendingEntryDao

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

See Also:

org.kuali.module.gl.dao.GeneralLedgerPendingEntryDao#findPendingLedgerEntries(org.kuali.ole.gl.businessobject.Encumbrance, boolean)

findPendingLedgerEntries

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

Description copied from interface: GeneralLedgerPendingEntryDao

This method retrieves all pending ledger entries for the given encumbrance

Specified by:

findPendingLedgerEntries in interface GeneralLedgerPendingEntryDao

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

See Also:

org.kuali.module.gl.dao.GeneralLedgerPendingEntryDao#findPendingLedgerEntries(org.kuali.ole.gl.businessobject.Balance, boolean, boolean)

findPendingLedgerEntriesForEntry

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

Description copied from interface: GeneralLedgerPendingEntryDao

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

Specified by:

findPendingLedgerEntriesForEntry in interface GeneralLedgerPendingEntryDao

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

Returns:

all pending ledger entries matching the given balance criteria

See Also:

org.kuali.ole.sys.dataaccess.GeneralLedgerPendingEntryDao#findPendingLedgerEntriesForEntry(java.util.Map, boolean, java.lang.String, int)

findPendingLedgerEntriesForBalance

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

Description copied from interface: GeneralLedgerPendingEntryDao

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

Specified by:

findPendingLedgerEntriesForBalance in interface GeneralLedgerPendingEntryDao

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

Returns:

all pending ledger entries matching the given balance criteria

See Also:

org.kuali.ole.sys.dataaccess.GeneralLedgerPendingEntryDao#findPendingLedgerEntriesForBalance(java.util.Map, boolean, java.lang.String, int)

findPendingLedgerEntriesForCashBalance

public Iterator findPendingLedgerEntriesForCashBalance(Map fieldValues,
                                              boolean isApproved,
                                              String currentFiscalPeriodCode,
                                              int currentFiscalYear,
                                              List<String> encumbranceBalanceType)

Description copied from interface: GeneralLedgerPendingEntryDao

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

Specified by:

findPendingLedgerEntriesForCashBalance in interface GeneralLedgerPendingEntryDao

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

currentFiscalYear - current fiscal year

encumbranceBalanceType - 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

See Also:

org.kuali.ole.sys.dataaccess.GeneralLedgerPendingEntryDao#findPendingLedgerEntriesForCashBalance(java.util.Map, boolean, java.lang.String, int)

findPendingLedgerEntriesForEncumbrance

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

Description copied from interface: GeneralLedgerPendingEntryDao

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

Specified by:

findPendingLedgerEntriesForEncumbrance in interface GeneralLedgerPendingEntryDao

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

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

See Also:

GeneralLedgerPendingEntryDao.findPendingLedgerEntriesForEncumbrance(java.util.Map, boolean, java.lang.String, int, org.kuali.ole.sys.businessobject.SystemOptions, java.util.List)

buildCriteriaToExcludeFundBalance

protected org.apache.ojb.broker.query.Criteria buildCriteriaToExcludeFundBalance(SystemOptions currentYearOptions)

This method creates Criteria that exclude the fund balance object type from the result.

Returns:

Criteria

findPendingLedgerEntriesForAccountBalance

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

Description copied from interface: GeneralLedgerPendingEntryDao

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

Specified by:

findPendingLedgerEntriesForAccountBalance in interface GeneralLedgerPendingEntryDao

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

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

See Also:

GeneralLedgerPendingEntryDao.findPendingLedgerEntriesForAccountBalance(Map, boolean, String, int, List)

findPendingLedgerEntrySummaryForAccountBalance

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

Description copied from interface: GeneralLedgerPendingEntryDao

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

Specified by:

findPendingLedgerEntrySummaryForAccountBalance in interface GeneralLedgerPendingEntryDao

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

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

See Also:

GeneralLedgerPendingEntryDao.findPendingLedgerEntrySummaryForAccountBalance(java.util.Map, boolean, java.lang.String, int, java.util.List)

buildAttributeList

protected List buildAttributeList()

This method builds the atrribute list used by balance searching

Returns:

List an attribute list

buildGroupList

protected List buildGroupList()

This method builds group by attribute list used by balance searching

Returns:

List an group by attribute list

addStatusCode

protected void addStatusCode(org.apache.ojb.broker.query.Criteria criteria,
                 boolean isOnlyApproved)

add the status code into the given criteria. The status code can be categorized into approved and all.

Parameters:

criteria - the given criteria

isApproved - the flag that indictates if only approved status code can be added into the given searach criteria

buildApprovalCodeList

protected List buildApprovalCodeList()

build a status code list including the legal approval codes

Returns:

an approval code list

buildCriteriaFromMap

public org.apache.ojb.broker.query.Criteria buildCriteriaFromMap(Map fieldValues,
                                                        Object businessObject,
                                                        String currentFiscalPeriodCode,
                                                        Integer currentFiscalYear,
                                                        List<String> encumbranceBalanceTypes)

This method builds an OJB query criteria based on the input field map

Parameters:

fieldValues - the input field map

businessObject - the given business object

Returns:

an OJB query criteria

findPendingEntries

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

Description copied from interface: GeneralLedgerPendingEntryDao

Find Pending Entries

Specified by:

findPendingEntries in interface GeneralLedgerPendingEntryDao

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:

See Also:

GeneralLedgerPendingEntryDao.findPendingEntries(java.util.Map, boolean, java.lang.String, int, java.util.List)

getEntryClass

public Class getEntryClass()

Gets the entryClass attribute.

Returns:

Returns the entryClass.

getEntryClassInstance

protected Object getEntryClassInstance()