org.kuali.ole.module.purap.document.dataaccess.impl

Class InvoiceDaoOjb

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.module.purap.document.dataaccess.impl.InvoiceDaoOjb

All Implemented Interfaces:

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

@Transactional
public class InvoiceDaoOjb
extends org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb
implements InvoiceDao

OJB Implementation of InvoiceDao.

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
InvoiceDaoOjb()

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getActiveInvoiceDocumentNumbersForPurchaseOrder(Integer purchaseOrderId) Retrieves a list of potentially active invoices for a purchase order by status code.
List<InvoiceDocument>	getActiveInvoicesByPOIdInvoiceAmountInvoiceDate(Integer poId, org.kuali.rice.core.api.util.type.KualiDecimal vendorInvoiceAmount, Date invoiceDate) Retrieves a list of Invoices with the given PO Id, invoice amount, and invoice date.
List<InvoiceDocument>	getActiveInvoicesByVendorNumber(Integer vendorHeaderGeneratedId, Integer vendorDetailAssignedId) Retrieves a list of invoices with the given vendor id and invoice number.
List<InvoiceDocument>	getActiveInvoicesByVendorNumberInvoiceNumber(Integer vendorHeaderGeneratedId, Integer vendorDetailAssignedId, String invoiceNumber) Retrieves a list of invoices with the given vendor id and invoice number.
String	getDocumentNumberByInvoiceId(Integer id) Get a invoice document number by id.
protected String	getDocumentNumberOfInvoiceByCriteria(org.apache.ojb.broker.query.Criteria criteria) Retrieves a document number for a invoice by user defined criteria.
List<String>	getDocumentNumbersByPurchaseOrderId(Integer poPurApId) Retrieves a list of document numbers by purchase order id.
protected List<String>	getDocumentNumbersOfInvoiceByCriteria(org.apache.ojb.broker.query.Criteria criteria, boolean orderByAscending) Retrieves a document number for a invoice by user defined criteria and sorts the values ascending if orderByAscending parameter is true, descending otherwise.
List<String>	getEligibleForAutoApproval(Date todayAtMidnight) Get all invoice documents that are eligible for auto-approval.
List<InvoiceDocument>	getImmediateInvoicesToExtract(String chartCode) Get all the invoices that are marked immediate that need to be extracted to PDP.
List<String>	getInvoiceInReceivingStatus() Get all invoice which are waiting in receiving status queue
protected List<InvoiceDocument>	getInvoicesByQueryByCriteria(org.apache.ojb.broker.query.QueryByCriteria qbc) Retrieves a list of invoices by user defined criteria.
List<InvoiceDocument>	getInvoicesToExtract(boolean onlySpecialPayments, String chartCode, Date onOrBeforeInvoicePayDate) The special payments query should be this: select * from pur.ap_pmt_rqst_t where pmt_rqst_stat_cd in ('AUTO', 'DPTA') and prcs_cmp_cd = ? and pmt_extrt_ts is NULL and pmt_hld_ind = 'N' and ( ( ( pmt_spcl_handlg_instrc_ln1_txt is not NULL or pmt_spcl_handlg_instrc_ln2_txt is not NULL or pmt_spcl_handlg_instrc_ln3_txt is not NULL or pmt_att_ind = 'Y') and trunc (pmt_rqst_pay_dt) <= trunc (sysdate)) or IMD_PMT_IND = 'Y')})
List<InvoiceDocument>	getInvoicesToExtract(String campusCode, Integer invoiceIdentifier, Integer purchaseOrderIdentifier, Integer vendorHeaderGeneratedIdentifier, Integer vendorDetailAssignedIdentifier, Date currentSqlDateMidnight) Deprecated.
Collection<InvoiceDocument>	getInvoicesToExtractForVendor(String campusCode, VendorGroupingHelper vendor, Date onOrBeforeInvoicePayDate) Get all the invoices that need to be extracted that match a credit memo.

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

Constructor Detail

InvoiceDaoOjb

public InvoiceDaoOjb()

Method Detail

getInvoicesToExtract

public List<InvoiceDocument> getInvoicesToExtract(boolean onlySpecialPayments,
                                         String chartCode,
                                         Date onOrBeforeInvoicePayDate)

The special payments query should be this: select * from pur.ap_pmt_rqst_t where pmt_rqst_stat_cd in ('AUTO', 'DPTA') and prcs_cmp_cd = ? and pmt_extrt_ts is NULL and pmt_hld_ind = 'N' and ( ( ( pmt_spcl_handlg_instrc_ln1_txt is not NULL or pmt_spcl_handlg_instrc_ln2_txt is not NULL or pmt_spcl_handlg_instrc_ln3_txt is not NULL or pmt_att_ind = 'Y') and trunc (pmt_rqst_pay_dt) <= trunc (sysdate)) or IMD_PMT_IND = 'Y')})

Specified by:

getInvoicesToExtract in interface InvoiceDao

Parameters:

onlySpecialPayments - - true only include special payments, False - include all

chartCode - - if not null, limit results to a single chart

Returns:

- Collection of invoices

See Also:

InvoiceDao.getInvoicesToExtract(boolean, String, Date)

getImmediateInvoicesToExtract

public List<InvoiceDocument> getImmediateInvoicesToExtract(String chartCode)

Description copied from interface: InvoiceDao

Get all the invoices that are marked immediate that need to be extracted to PDP.

Specified by:

getImmediateInvoicesToExtract in interface InvoiceDao

Parameters:

chartCode - - chart of accounts code

Returns:

- Collection of invoices

See Also:

InvoiceDao.getImmediateInvoicesToExtract(String)

getInvoicesToExtract

@Deprecated
public List<InvoiceDocument> getInvoicesToExtract(String campusCode,
                                                    Integer invoiceIdentifier,
                                                    Integer purchaseOrderIdentifier,
                                                    Integer vendorHeaderGeneratedIdentifier,
                                                    Integer vendorDetailAssignedIdentifier,
                                                    Date currentSqlDateMidnight)

Deprecated.

Description copied from interface: InvoiceDao

Get all the invoices that need to be extracted that match a credit memo.

Specified by:

getInvoicesToExtract in interface InvoiceDao

Parameters:

campusCode - - limit results to a single chart

invoiceIdentifier - - Invoice Identifier (can be null)

purchaseOrderIdentifier - - PO Identifier (can be null)

vendorHeaderGeneratedIdentifier - - Vendor Header ID

vendorDetailAssignedIdentifier - - Vendor Detail ID

currentSqlDateMidnight - current SQL date midnight

Returns:

- list of invoices that need to be extracted

See Also:

InvoiceDao.getInvoicesToExtract(String, Integer, Integer, Integer, Integer, Date)

getInvoicesToExtractForVendor

public Collection<InvoiceDocument> getInvoicesToExtractForVendor(String campusCode,
                                                        VendorGroupingHelper vendor,
                                                        Date onOrBeforeInvoicePayDate)

Description copied from interface: InvoiceDao

Get all the invoices that need to be extracted that match a credit memo.

Specified by:

getInvoicesToExtractForVendor in interface InvoiceDao

Parameters:

campusCode - - limit results to a single chart

vendor - - Vendor Header ID, Vendor Detail ID, Country, Zip Code

onOrBeforeInvoicePayDate - only invoices with a pay date on or before this value will be returned in the iterator

Returns:

- list of invoices that need to be extracted

See Also:

InvoiceDao.getInvoicesToExtractForVendor(String, org.kuali.ole.module.purap.util.VendorGroupingHelper, Date)

getEligibleForAutoApproval

public List<String> getEligibleForAutoApproval(Date todayAtMidnight)

Description copied from interface: InvoiceDao

Get all invoice documents that are eligible for auto-approval. Whether or not a document is eligible for auto-approval is determined according to whether or not the document total is below a pre-determined minimum amount. This amount is derived from the accounts, charts and/or organizations associated with a given document. If no minimum amount can be determined from chart associations a default minimum specified as a system parameter is used to determine the minimum amount threshold.

Specified by:

getEligibleForAutoApproval in interface InvoiceDao

Returns:

- an Iterator over all invoice documents eligible for automatic approval

See Also:

InvoiceDao.getEligibleForAutoApproval(Date)

getDocumentNumberByInvoiceId

public String getDocumentNumberByInvoiceId(Integer id)

Description copied from interface: InvoiceDao

Get a invoice document number by id.

Specified by:

getDocumentNumberByInvoiceId in interface InvoiceDao

Parameters:

id - - Invoice Id

Returns:

- Invoice or null if not found

See Also:

InvoiceDao.getDocumentNumberByInvoiceId(Integer)

getDocumentNumbersByPurchaseOrderId

public List<String> getDocumentNumbersByPurchaseOrderId(Integer poPurApId)

Description copied from interface: InvoiceDao

Retrieves a list of document numbers by purchase order id.

Specified by:

getDocumentNumbersByPurchaseOrderId in interface InvoiceDao

Parameters:

poPurApId - - purchase order id

Returns:

- list of document numbers

See Also:

InvoiceDao.getDocumentNumbersByPurchaseOrderId(Integer)

getDocumentNumberOfInvoiceByCriteria

protected String getDocumentNumberOfInvoiceByCriteria(org.apache.ojb.broker.query.Criteria criteria)

Retrieves a document number for a invoice by user defined criteria.

Parameters:

criteria - - list of criteria to use in the retrieve

Returns:

- document number

getDocumentNumbersOfInvoiceByCriteria

protected List<String> getDocumentNumbersOfInvoiceByCriteria(org.apache.ojb.broker.query.Criteria criteria,
                                                 boolean orderByAscending)

Retrieves a document number for a invoice by user defined criteria and sorts the values ascending if orderByAscending parameter is true, descending otherwise.

Parameters:

criteria - - list of criteria to use in the retrieve

orderByAscending - - boolean to sort results ascending if true, descending otherwise

Returns:

- Iterator of document numbers

getInvoicesByQueryByCriteria

protected List<InvoiceDocument> getInvoicesByQueryByCriteria(org.apache.ojb.broker.query.QueryByCriteria qbc)

Retrieves a list of invoices by user defined criteria.

Parameters:

qbc - - query with criteria

Returns:

- list of invoices

getActiveInvoicesByVendorNumberInvoiceNumber

public List<InvoiceDocument> getActiveInvoicesByVendorNumberInvoiceNumber(Integer vendorHeaderGeneratedId,
                                                                 Integer vendorDetailAssignedId,
                                                                 String invoiceNumber)

Retrieves a list of invoices with the given vendor id and invoice number.

Specified by:

getActiveInvoicesByVendorNumberInvoiceNumber in interface InvoiceDao

Parameters:

vendorHeaderGeneratedId - - header id of the vendor id

vendorDetailAssignedId - - detail id of the vendor id

invoiceNumber - - invoice number as entered by AP

Returns:

- List of invoices.

getActiveInvoicesByVendorNumber

public List<InvoiceDocument> getActiveInvoicesByVendorNumber(Integer vendorHeaderGeneratedId,
                                                    Integer vendorDetailAssignedId)

Retrieves a list of invoices with the given vendor id and invoice number.

Specified by:

getActiveInvoicesByVendorNumber in interface InvoiceDao

Parameters:

vendorHeaderGeneratedId - - header id of the vendor id

vendorDetailAssignedId - - detail id of the vendor id

Returns:

- List of invoices.

getActiveInvoicesByPOIdInvoiceAmountInvoiceDate

public List<InvoiceDocument> getActiveInvoicesByPOIdInvoiceAmountInvoiceDate(Integer poId,
                                                                    org.kuali.rice.core.api.util.type.KualiDecimal vendorInvoiceAmount,
                                                                    Date invoiceDate)

Description copied from interface: InvoiceDao

Retrieves a list of Invoices with the given PO Id, invoice amount, and invoice date.

Specified by:

getActiveInvoicesByPOIdInvoiceAmountInvoiceDate in interface InvoiceDao

Parameters:

poId - - purchase order ID

vendorInvoiceAmount - - amount of the invoice as entered by AP

invoiceDate - - date of the invoice as entered by AP

Returns:

- List of Pay Reqs.

See Also:

InvoiceDao.getActiveInvoicesByPOIdInvoiceAmountInvoiceDate(Integer, org.kuali.rice.core.api.util.type.KualiDecimal, java.sql.Date)

getActiveInvoiceDocumentNumbersForPurchaseOrder

public List<String> getActiveInvoiceDocumentNumbersForPurchaseOrder(Integer purchaseOrderId)

Description copied from interface: InvoiceDao

Retrieves a list of potentially active invoices for a purchase order by status code. Active being defined as being enroute and before final. The issue is that a status of vendor_tax_review may not mean that it's in review, but could be in final (as there isn't a final status code for invoice). Workflow status must be checked further after retrieval.

Specified by:

getActiveInvoiceDocumentNumbersForPurchaseOrder in interface InvoiceDao

Returns:

getInvoiceInReceivingStatus

public List<String> getInvoiceInReceivingStatus()

Description copied from interface: InvoiceDao

Get all invoice which are waiting in receiving status queue

Specified by:

getInvoiceInReceivingStatus in interface InvoiceDao

Returns: