org.kuali.kfs.module.tem.dataaccess.impl

Class TravelDocumentDaoOjb

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.kfs.module.tem.dataaccess.impl.TravelDocumentDaoOjb

All Implemented Interfaces:

TravelDocumentDao, org.kuali.rice.core.framework.persistence.dao.PlatformAwareDao, org.kuali.rice.krad.util.OjbCollectionAware, org.springframework.beans.factory.InitializingBean

public class TravelDocumentDaoOjb
extends org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb
implements TravelDocumentDao, org.kuali.rice.krad.util.OjbCollectionAware

This class is the OJB implementation of the DocumentDao interface.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	LOG

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

logger

Constructor Summary

Constructors

Constructor and Description
TravelDocumentDaoOjb()

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	findDocumentNumbers(Class<?> travelDocumentClass, String travelDocumentNumber)
List<TravelDocument>	findDocuments(Class<?> travelDocumentClass, String travelDocumentNumber)
List<PerDiem>	findEffectivePerDiems(int primaryDestinationId, Date effectiveDate) PerDiem lookup base on search values PER_DIEM_LOOKUP_DATE can also be passed in for a custom date duration search
Object[]	findLatestTaxableRamificationNotificationDate() find the latest taxable ramification notification date
Collection<? extends TEMReimbursementDocument>	findMatchingTrips(Integer temProfileId, Timestamp tripBegin, Timestamp tripEnd) Retrieves duplicate trips for traveler with given trip begin and end date
Collection<? extends TravelAuthorizationDocument>	getAuthorizationsAndAmendmentsByHeaderStatus(String statusCode, boolean immediatesOnly) Retrieves all TravelAuthorization and TravelAuthorizationAmendment documents with the given financial system document header status
Collection<? extends TEMReimbursementDocument>	getEntertainmentDocumentsByHeaderStatus(String statusCode, boolean immediatesOnly) Retrieves all Entertainment documents with the given financial system document header status
Collection<? extends TEMReimbursementDocument>	getEntertainmentDocumentsNeedingCorporateCardExtraction() Retrieves all entertainment reimbursement documents which have corporate card expenses to extract but which have not yet been extracted
List<TravelAdvance>	getOutstandingTravelAdvanceByInvoice(Set<String> arInvoiceDocNumbers) get all outstanding travel advances by the given invoice document numbers.
Collection<? extends TEMReimbursementDocument>	getReimbursementDocumentsByHeaderStatus(String statusCode, boolean immediatesOnly) Retrieves all Travel Reimbursement documents with the given financial system document header status
Collection<? extends TEMReimbursementDocument>	getReimbursementDocumentsNeedingCorporateCardExtraction() Retrieves all travel reimbursement documents which have corporate card expenses to extract but which have not yet been extracted
Collection<? extends TEMReimbursementDocument>	getRelocationDocumentsByHeaderStatus(String statusCode, boolean immediatesOnly) Retrieves all Travel Relocation documents with the given financial system document header status
Collection<? extends TEMReimbursementDocument>	getRelocationDocumentsNeedingCorporateCardExtraction() Retrieves all moving and relocation reimbursement documents which have corporate card expenses to extract but which have not yet been extracted
protected Collection<? extends TravelDocument>	getTravelDocumentsByHeaderStatus(Class<? extends TravelDocument> documentClazz, String statusCode, boolean immediatesOnly, String travelPaymentProperty) Do a lookup of reimbursable documents of the given class with the given financial system document header status code and a payment method of "check" (ie, PDP will pay out)
protected Collection<? extends TravelDocument>	getUnExtractedCorporateCardTravelDocuments(Class<? extends TravelDocument> documentClazz) Retrieves all documents of the given TravelDocument class that a) are extracted or approved by document header, but b) have a null corporate card extraction date and c) actually have corporate card expenses

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

Methods inherited from interface org.kuali.rice.krad.util.OjbCollectionAware

getPersistenceBrokerTemplate

Field Detail

LOG

public static org.apache.log4j.Logger LOG

Constructor Detail

TravelDocumentDaoOjb

public TravelDocumentDaoOjb()

Method Detail

findDocuments

public List<TravelDocument> findDocuments(Class<?> travelDocumentClass,
                                 String travelDocumentNumber)

Specified by:

findDocuments in interface TravelDocumentDao

travelDocumentNumber - to refer to for travel document results

Returns:

findDocumentNumbers

public List<String> findDocumentNumbers(Class<?> travelDocumentClass,
                               String travelDocumentNumber)

Specified by:

findDocumentNumbers in interface TravelDocumentDao

travelDocumentNumber - to refer to for travel document results

Returns:

findEffectivePerDiems

public List<PerDiem> findEffectivePerDiems(int primaryDestinationId,
                                  Date effectiveDate)

Description copied from interface: TravelDocumentDao

PerDiem lookup base on search values PER_DIEM_LOOKUP_DATE can also be passed in for a custom date duration search

Specified by:

findEffectivePerDiems in interface TravelDocumentDao

Parameters:

primaryDestinationId - the id of the primary destination to find dates for

effectiveDate - the date we should use against the effective dates

Returns:

deprecated because we're looking for a better way to do this

See Also:

org.kuali.kfs.module.tem.dataaccess.TravelDocumentDao#findPerDiem(int, java.sql.Date, java.sql.Date)

getOutstandingTravelAdvanceByInvoice

public List<TravelAdvance> getOutstandingTravelAdvanceByInvoice(Set<String> arInvoiceDocNumbers)

Description copied from interface: TravelDocumentDao

get all outstanding travel advances by the given invoice document numbers. The advances must have not been used to generate taxable ramification

Specified by:

getOutstandingTravelAdvanceByInvoice in interface TravelDocumentDao

Returns:

a list of outstanding travel advances

See Also:

TravelDocumentDao.getOutstandingTravelAdvanceByInvoice(java.util.Set)

findLatestTaxableRamificationNotificationDate

public Object[] findLatestTaxableRamificationNotificationDate()

Description copied from interface: TravelDocumentDao

find the latest taxable ramification notification date

Specified by:

findLatestTaxableRamificationNotificationDate in interface TravelDocumentDao

Returns:

the latest taxable ramification notification date

See Also:

TravelDocumentDao.findLatestTaxableRamificationNotificationDate()

getReimbursementDocumentsByHeaderStatus

public Collection<? extends TEMReimbursementDocument> getReimbursementDocumentsByHeaderStatus(String statusCode,
                                                                                     boolean immediatesOnly)

Description copied from interface: TravelDocumentDao

Retrieves all Travel Reimbursement documents with the given financial system document header status

Specified by:

getReimbursementDocumentsByHeaderStatus in interface TravelDocumentDao

Parameters:

statusCode - the financial system document header status of the documents to retrieve

immediatesOnly - true if only those documents marked for immediate payment are to be retrieved, false if all documents at the status are to be retrieved

Returns:

a Collection of qualifying Travel Reimbursement documents

See Also:

TravelDocumentDao.getReimbursementDocumentsByHeaderStatus(java.lang.String, boolean)

getRelocationDocumentsByHeaderStatus

public Collection<? extends TEMReimbursementDocument> getRelocationDocumentsByHeaderStatus(String statusCode,
                                                                                  boolean immediatesOnly)

Description copied from interface: TravelDocumentDao

Retrieves all Travel Relocation documents with the given financial system document header status

Specified by:

getRelocationDocumentsByHeaderStatus in interface TravelDocumentDao

Parameters:

statusCode - the financial system document header status of the documents to retrieve

immediatesOnly - true if only those documents marked for immediate payment are to be retrieved, false if all documents at the status are to be retrieved

Returns:

a Collection of qualifying Travel Relocation documents

See Also:

TravelDocumentDao.getRelocationDocumentsByHeaderStatus(java.lang.String, boolean)

getEntertainmentDocumentsByHeaderStatus

public Collection<? extends TEMReimbursementDocument> getEntertainmentDocumentsByHeaderStatus(String statusCode,
                                                                                     boolean immediatesOnly)

Description copied from interface: TravelDocumentDao

Retrieves all Entertainment documents with the given financial system document header status

Specified by:

getEntertainmentDocumentsByHeaderStatus in interface TravelDocumentDao

Parameters:

statusCode - the financial system document header status of the documents to retrieve

immediatesOnly - true if only those documents marked for immediate payment are to be retrieved, false if all documents at the status are to be retrieved

Returns:

a Collection of qualifying Entertainment documents

See Also:

TravelDocumentDao.getEntertainmentDocumentsByHeaderStatus(java.lang.String, boolean)

getAuthorizationsAndAmendmentsByHeaderStatus

public Collection<? extends TravelAuthorizationDocument> getAuthorizationsAndAmendmentsByHeaderStatus(String statusCode,
                                                                                             boolean immediatesOnly)

Description copied from interface: TravelDocumentDao

Retrieves all TravelAuthorization and TravelAuthorizationAmendment documents with the given financial system document header status

Specified by:

getAuthorizationsAndAmendmentsByHeaderStatus in interface TravelDocumentDao

Parameters:

statusCode - the financial system document header status of the documents to retrieve

immediatesOnly - true if only those documents marked for immediate payment are to be retrieved, false if all documents at the status are to be retrieved

Returns:

a Collection of qualifying authorization documents

See Also:

org.kuali.kfs.module.tem.dataaccess.TravelDocumentDao#getAuthorizationDocumentsByHeaderStatus(java.lang.String, boolean)

getTravelDocumentsByHeaderStatus

protected Collection<? extends TravelDocument> getTravelDocumentsByHeaderStatus(Class<? extends TravelDocument> documentClazz,
                                                                    String statusCode,
                                                                    boolean immediatesOnly,
                                                                    String travelPaymentProperty)

Do a lookup of reimbursable documents of the given class with the given financial system document header status code and a payment method of "check" (ie, PDP will pay out)

Parameters:

documentClazz - the class of the document to look up

statusCode - the status code of the documents to look up

immediatesOnly - true if only those reimbursable documents

Returns:

a Collection of qualifying documents

getReimbursementDocumentsNeedingCorporateCardExtraction

public Collection<? extends TEMReimbursementDocument> getReimbursementDocumentsNeedingCorporateCardExtraction()

Retrieves all travel reimbursement documents which have corporate card expenses to extract but which have not yet been extracted

Specified by:

getReimbursementDocumentsNeedingCorporateCardExtraction in interface TravelDocumentDao

Returns:

a Collection of qualifying reimbursement documents

See Also:

TravelDocumentDao.getReimbursementDocumentsNeedingCorporateCardExtraction()

getEntertainmentDocumentsNeedingCorporateCardExtraction

public Collection<? extends TEMReimbursementDocument> getEntertainmentDocumentsNeedingCorporateCardExtraction()

Retrieves all entertainment reimbursement documents which have corporate card expenses to extract but which have not yet been extracted

Specified by:

getEntertainmentDocumentsNeedingCorporateCardExtraction in interface TravelDocumentDao

Returns:

a Collection of qualifying reimbursement documents

See Also:

TravelDocumentDao.getReimbursementDocumentsNeedingCorporateCardExtraction()

getRelocationDocumentsNeedingCorporateCardExtraction

public Collection<? extends TEMReimbursementDocument> getRelocationDocumentsNeedingCorporateCardExtraction()

Retrieves all moving and relocation reimbursement documents which have corporate card expenses to extract but which have not yet been extracted

Specified by:

getRelocationDocumentsNeedingCorporateCardExtraction in interface TravelDocumentDao

Returns:

a Collection of qualifying reimbursement documents

See Also:

TravelDocumentDao.getReimbursementDocumentsNeedingCorporateCardExtraction()

getUnExtractedCorporateCardTravelDocuments

protected Collection<? extends TravelDocument> getUnExtractedCorporateCardTravelDocuments(Class<? extends TravelDocument> documentClazz)

Retrieves all documents of the given TravelDocument class that a) are extracted or approved by document header, but b) have a null corporate card extraction date and c) actually have corporate card expenses

Parameters:

documentClazz - the class of the travel documents to retrieve

Returns:

a Collection of matching documents

findMatchingTrips

public Collection<? extends TEMReimbursementDocument> findMatchingTrips(Integer temProfileId,
                                                               Timestamp tripBegin,
                                                               Timestamp tripEnd)

Description copied from interface: TravelDocumentDao

Retrieves duplicate trips for traveler with given trip begin and end date

Specified by:

findMatchingTrips in interface TravelDocumentDao

Returns: