org.kuali.kfs.fp.document.dataaccess.impl
Class CashManagementDaoOjb

java.lang.Object
  org.springframework.dao.support.DaoSupport
      org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport
          org.kuali.rice.kns.dao.impl.PlatformAwareDaoBaseOjb
              org.kuali.kfs.fp.document.dataaccess.impl.CashManagementDaoOjb

All Implemented Interfaces:

CashManagementDao, org.kuali.rice.kns.dao.PlatformAwareDao, org.springframework.beans.factory.InitializingBean

public class CashManagementDaoOjb
extends org.kuali.rice.kns.dao.impl.PlatformAwareDaoBaseOjb
implements CashManagementDao

Field Summary

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

logger

Constructor Summary

CashManagementDaoOjb()

Method Summary

protected org.apache.ojb.broker.query.Criteria	createDepositedCashieringCheckCriteria(String documentNumber) This method creates the criteria to find deposited checks
protected org.apache.ojb.broker.query.Criteria	createDepositedCashieringCheckCriteria(String documentNumber, Integer depositLineNumber) This method creates a criteria to find the cashiering checks associated with a given deposit
protected org.apache.ojb.broker.query.Criteria	createUndepositedCashieringCheckCriteria(String documentNumber) This method creates the criteria to find undeposited cashiering checks
CoinDetail	findCoinDetailByCashieringRecordSource(String documentNumber, String documentTypeCode, String cashieringRecordSource) Retrieves all coin detail records with the given document number, document type code, and cashiering record source
CurrencyDetail	findCurrencyDetailByCashieringRecordSource(String documentNumber, String documentTypeCode, String cashieringRecordSource) Retrieves all currency detail records with the given document number, document type code, and cashiering record source
List<CashieringItemInProcess>	findOpenItemsInProcessByCampusCode(String campusCode) This method returns a list of open items in process for a given campus code
List<CashieringItemInProcess>	findRecentlyClosedItemsInProcess(String campusCode) This finds items in process associated with the given campus code closed within the past 30 days.
protected org.apache.ojb.broker.query.Criteria	getAllCashDetailCriteria(String documentNumber) This method creates details for getting all of a certain cash detail, irregardless of cashiering record source
List<CoinDetail>	getAllCoinDetails(String documentNumber) This method gets all coin details for a particular document number, irregardless of cashiering record source
List<CurrencyDetail>	getAllCurrencyDetails(String documentNumber) This method retrieves all currency details associated with a cash management document
protected org.apache.ojb.broker.query.Criteria	getCashDetailCriteria(String documentNumber, String documentTypeCode, String cashieringRecordSource) This takes the primary keys for a cash or currency detail record and returns an OJB criteria for it
protected List<Check>	putResultsIntoCheckList(Iterator iter) This method puts the check elements of an iterator into a list
protected Object	retrieveCashDetail(String documentNumber, String documentTypeCode, String cashieringRecordSource, Class detailType) This method retrieves a cash detail from the database
List<Check>	selectCashieringChecksForDeposit(String documentNumber, Integer depositLineNumber) Retrieves from the database all cashiering transaction checks deposited for a given deposit
List<Check>	selectDepositedCashieringChecks(String documentNumber) Retrieves all deposited cashiering checks from the database
Integer	selectNextAvailableCheckLineNumber(String documentNumber) Select the next available check line number for the given cash management document
List<Check>	selectUndepositedCashieringChecks(String documentNumber) Retrieves from the database any undeposited cashiering transaction checks associated with the given cash management document

Methods inherited from class org.kuali.rice.kns.dao.impl.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

Constructor Detail

CashManagementDaoOjb

public CashManagementDaoOjb()

Method Detail

findOpenItemsInProcessByCampusCode

public List<CashieringItemInProcess> findOpenItemsInProcessByCampusCode(String campusCode)
                                                                 throws org.springframework.dao.DataAccessException

Description copied from interface: CashManagementDao

This method returns a list of open items in process for a given campus code

Specified by:

findOpenItemsInProcessByCampusCode in interface CashManagementDao

Parameters:

campusCode - the campus code to use to search open items in process for

Returns:

a list of open items in process

Throws:

org.springframework.dao.DataAccessException

See Also:

CashManagementDao.findOpenItemsInProcessByCampusCode(java.lang.String)

findRecentlyClosedItemsInProcess

public List<CashieringItemInProcess> findRecentlyClosedItemsInProcess(String campusCode)

Description copied from interface: CashManagementDao

This finds items in process associated with the given campus code closed within the past 30 days.

Specified by:

findRecentlyClosedItemsInProcess in interface CashManagementDao

Parameters:

campusCode - the campus code that the found items in process should be associated with

Returns:

a list of CashieringItemInProcess records

See Also:

CashManagementDao.findRecentlyClosedItemsInProcess(java.lang.String)

findCoinDetailByCashieringRecordSource

public CoinDetail findCoinDetailByCashieringRecordSource(String documentNumber,
                                                         String documentTypeCode,
                                                         String cashieringRecordSource)

Description copied from interface: CashManagementDao

Retrieves all coin detail records with the given document number, document type code, and cashiering record source

Specified by:

findCoinDetailByCashieringRecordSource in interface CashManagementDao

Parameters:

documentNumber - the document the coin details were associated with

documentTypeCode - the type of that document

cashieringRecordSource - the cashiering record source

Returns:

a list of coin details meeting those criteria

See Also:

CashManagementDao.findCoinDetailByCashieringRecordSource(java.lang.String, java.lang.String, java.lang.String)

findCurrencyDetailByCashieringRecordSource

public CurrencyDetail findCurrencyDetailByCashieringRecordSource(String documentNumber,
                                                                 String documentTypeCode,
                                                                 String cashieringRecordSource)

Description copied from interface: CashManagementDao

Retrieves all currency detail records with the given document number, document type code, and cashiering record source

Specified by:

findCurrencyDetailByCashieringRecordSource in interface CashManagementDao

Parameters:

documentNumber - the document number this currency detail was associated with

documentTypeCode - the type code of that document

cashieringRecordSource - the cashiering record source

Returns:

a list of currency details matching that criteria

See Also:

CashManagementDao.findCurrencyDetailByCashieringRecordSource(java.lang.String, java.lang.String, java.lang.String)

getCashDetailCriteria

protected org.apache.ojb.broker.query.Criteria getCashDetailCriteria(String documentNumber,
                                                                     String documentTypeCode,
                                                                     String cashieringRecordSource)

This takes the primary keys for a cash or currency detail record and returns an OJB criteria for it

Parameters:

documentNumber - document number to retrieve

documentTypeCode - type code of the document

cashieringRecordSource - the cashiering record source

Returns:

a criteria, based on all of the given information

retrieveCashDetail

protected Object retrieveCashDetail(String documentNumber,
                                    String documentTypeCode,
                                    String cashieringRecordSource,
                                    Class detailType)

This method retrieves a cash detail from the database

Parameters:

documentNumber - the document number to retrieve from

documentTypeCode - the document type of the document the cash detail to look up is associated with

cashieringRecordSource - the cashiering record source to look up from

detailType - the class of the cash detail type we want

Returns:

the cash detail type record

selectCashieringChecksForDeposit

public List<Check> selectCashieringChecksForDeposit(String documentNumber,
                                                    Integer depositLineNumber)

Description copied from interface: CashManagementDao

Retrieves from the database all cashiering transaction checks deposited for a given deposit

Specified by:

selectCashieringChecksForDeposit in interface CashManagementDao

Parameters:

documentNumber - the document number of a cash management document that cashiering transaction checks have been deposited for

depositLineNumber - the line number of the deposit to find checks deposited for

Returns:

a list of checks associated with the given deposit

See Also:

CashManagementDao.selectCashieringChecksForDeposit(java.lang.String, java.lang.Integer)

createDepositedCashieringCheckCriteria

protected org.apache.ojb.broker.query.Criteria createDepositedCashieringCheckCriteria(String documentNumber,
                                                                                      Integer depositLineNumber)

This method creates a criteria to find the cashiering checks associated with a given deposit

Parameters:

documentNumber - the document number the deposit is associated with

depositLineNumber - the line number of the deposit

Returns:

a criteria to find those checks

putResultsIntoCheckList

protected List<Check> putResultsIntoCheckList(Iterator iter)

This method puts the check elements of an iterator into a list

Parameters:

iter - an iterator with checks results in it

Returns:

a list of checks

selectUndepositedCashieringChecks

public List<Check> selectUndepositedCashieringChecks(String documentNumber)

Description copied from interface: CashManagementDao

Retrieves from the database any undeposited cashiering transaction checks associated with the given cash management document

Specified by:

selectUndepositedCashieringChecks in interface CashManagementDao

Parameters:

documentNumber - the document number of a cash management document that cashiering transaction checks may be associated with

Returns:

a list of checks associated with the document

See Also:

CashManagementDao.selectUndepositedCashieringChecks(java.lang.String)

createUndepositedCashieringCheckCriteria

protected org.apache.ojb.broker.query.Criteria createUndepositedCashieringCheckCriteria(String documentNumber)

This method creates the criteria to find undeposited cashiering checks

Parameters:

documentNumber - the document number undeposited checks are associated with

Returns:

a criteria to find them

selectDepositedCashieringChecks

public List<Check> selectDepositedCashieringChecks(String documentNumber)

Description copied from interface: CashManagementDao

Retrieves all deposited cashiering checks from the database

Specified by:

selectDepositedCashieringChecks in interface CashManagementDao

Parameters:

documentNumber - the document to get checks associated with

Returns:

a list of deposited checks

See Also:

CashManagementDao.selectDepositedCashieringChecks(java.lang.String)

createDepositedCashieringCheckCriteria

protected org.apache.ojb.broker.query.Criteria createDepositedCashieringCheckCriteria(String documentNumber)

This method creates the criteria to find deposited checks

Parameters:

documentNumber - the CM document the checks are associated with

Returns:

a criteria to find deposited checks

getAllCurrencyDetails

public List<CurrencyDetail> getAllCurrencyDetails(String documentNumber)

This method retrieves all currency details associated with a cash management document

Specified by:

getAllCurrencyDetails in interface CashManagementDao

Parameters:

documentNumber - the document number of the cash management document to get currency details for

Returns:

a list of currency details

getAllCoinDetails

public List<CoinDetail> getAllCoinDetails(String documentNumber)

This method gets all coin details for a particular document number, irregardless of cashiering record source

Specified by:

getAllCoinDetails in interface CashManagementDao

Parameters:

documentNumber - the document number to find cash details for

Returns:

hopefully, a bunch of coin details

getAllCashDetailCriteria

protected org.apache.ojb.broker.query.Criteria getAllCashDetailCriteria(String documentNumber)

This method creates details for getting all of a certain cash detail, irregardless of cashiering record source

Parameters:

documentNumber - the document number to get cash details for

Returns:

the criteria that will allow the retrieval of the right cash details

selectNextAvailableCheckLineNumber

public Integer selectNextAvailableCheckLineNumber(String documentNumber)

Description copied from interface: CashManagementDao

Select the next available check line number for the given cash management document

Specified by:

selectNextAvailableCheckLineNumber in interface CashManagementDao

Parameters:

documentNumber - the document number of a cash management document

Returns:

the next available check line number for cashiering checks

See Also:

CashManagementDao.selectNextAvailableCheckLineNumber(java.lang.String)