org.kuali.kfs.module.purap.document.dataaccess.impl
Class CreditMemoDaoOjb

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

All Implemented Interfaces:

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

public class CreditMemoDaoOjb
extends org.kuali.rice.kns.dao.impl.PlatformAwareDaoBaseOjb
implements CreditMemoDao

OJB Implementation of CreditMemoDao. Provides persistence layer methods for the credit memo document.

Field Summary

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

logger

Constructor Summary

CreditMemoDaoOjb()

Method Summary

boolean	duplicateExists(Integer vendorNumberHeaderId, Integer vendorNumberDetailId, Date date, org.kuali.rice.kns.util.KualiDecimal amount) This method tests for a duplicate entry of a credit memo by the combination of vendor number header id, vendor detail id, date and amount.
boolean	duplicateExists(Integer vendorNumberHeaderId, Integer vendorNumberDetailId, String creditMemoNumber) This method tests for a duplicate entry of a credit memo by the combination of vendorNumber HeaderId, vendorNumber and creditMemoNumber.
List<String>	getActiveCreditMemoDocumentNumbersForPurchaseOrder(Integer purchaseOrderId) Retrieves a list of potentially active credit memos for a purchase order by status code.
Iterator<VendorCreditMemoDocument>	getCreditMemosToExtract(String chartCode) Get all the credit memos that need to be extracted
Collection<VendorCreditMemoDocument>	getCreditMemosToExtractByVendor(String chartCode, VendorGroupingHelper vendor) Get all the credit memos that need to be extracted for a particular vendor record.
String	getDocumentNumberByCreditMemoId(Integer id) This method returns a credit memo document number by id.
protected String	getDocumentNumberOfCreditMemoByCriteria(org.apache.ojb.broker.query.Criteria criteria) Retrieves a document number for a credit memo by user defined criteria.
protected Iterator<Object[]>	getDocumentNumbersOfCreditMemoByCriteria(org.apache.ojb.broker.query.Criteria criteria, boolean orderByAscending) Retrieves a document number for a credit memo by user defined criteria and sorts the values ascending if orderByAscending parameter is true, descending otherwise.

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

CreditMemoDaoOjb

public CreditMemoDaoOjb()

Method Detail

getCreditMemosToExtract

public Iterator<VendorCreditMemoDocument> getCreditMemosToExtract(String chartCode)

Description copied from interface: CreditMemoDao

Get all the credit memos that need to be extracted

Specified by:

getCreditMemosToExtract in interface CreditMemoDao

Parameters:

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

Returns:

- Iterator of credit memos

See Also:

CreditMemoDao.getCreditMemosToExtract(java.lang.String)

getCreditMemosToExtractByVendor

public Collection<VendorCreditMemoDocument> getCreditMemosToExtractByVendor(String chartCode,
                                                                            VendorGroupingHelper vendor)

Description copied from interface: CreditMemoDao

Get all the credit memos that need to be extracted for a particular vendor record.

Specified by:

getCreditMemosToExtractByVendor in interface CreditMemoDao

Parameters:

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

Returns:

- Iterator of credit memos

See Also:

org.kuali.kfs.module.purap.document.dataaccess.CreditMemoDao#getCreditMemosToExtractByVendor(java.lang.String, java.lang.Integer, java.lang.Integer)

duplicateExists

public boolean duplicateExists(Integer vendorNumberHeaderId,
                               Integer vendorNumberDetailId,
                               String creditMemoNumber)

Description copied from interface: CreditMemoDao

This method tests for a duplicate entry of a credit memo by the combination of vendorNumber HeaderId, vendorNumber and creditMemoNumber. This method accepts the three values as arguments, and returns a boolean, describing whether a duplicate exists in the system or not.

Specified by:

duplicateExists in interface CreditMemoDao

Parameters:

vendorNumberHeaderId - - vendor number header id

creditMemoNumber - - the vendor-supplied creditMemoNumber

Returns:

boolean - true if a match exists in the db, false if not

See Also:

edu.iu.uis.pur.cm.dao.CreditMemoDao#duplicateExists(java.lang.String, java.lang.String)

duplicateExists

public boolean duplicateExists(Integer vendorNumberHeaderId,
                               Integer vendorNumberDetailId,
                               Date date,
                               org.kuali.rice.kns.util.KualiDecimal amount)

Description copied from interface: CreditMemoDao

This method tests for a duplicate entry of a credit memo by the combination of vendor number header id, vendor detail id, date and amount. This method accepts the values as arguments, and returns a boolean, describing whether a duplicate exists in the system or not.

Specified by:

duplicateExists in interface CreditMemoDao

date - - date of transaction

amount - - amount of transaction

Returns:

boolean - true if a match exists in the db, false if not

See Also:

edu.iu.uis.pur.cm.dao.CreditMemoDao#duplicateExists(java.lang.String, java.lang.String)

getDocumentNumberByCreditMemoId

public String getDocumentNumberByCreditMemoId(Integer id)

Description copied from interface: CreditMemoDao

This method returns a credit memo document number by id.

Specified by:

getDocumentNumberByCreditMemoId in interface CreditMemoDao

Parameters:

id - - credit memo id

Returns:

- document number

See Also:

CreditMemoDao.getDocumentNumberByCreditMemoId(java.lang.Integer)

getDocumentNumberOfCreditMemoByCriteria

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

Retrieves a document number for a credit memo by user defined criteria.

Parameters:

criteria - - holds field and value pairs defined by the calling method

Returns:

- document number

getDocumentNumbersOfCreditMemoByCriteria

protected Iterator<Object[]> getDocumentNumbersOfCreditMemoByCriteria(org.apache.ojb.broker.query.Criteria criteria,
                                                                      boolean orderByAscending)

Retrieves a document number for a credit memo 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 indicating results should be sorted ascending, descending otherwise

Returns:

- Iterator of document numbers

getActiveCreditMemoDocumentNumbersForPurchaseOrder

public List<String> getActiveCreditMemoDocumentNumbersForPurchaseOrder(Integer purchaseOrderId)

Description copied from interface: CreditMemoDao

Retrieves a list of potentially active credit memos 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 payment request). Workflow status must be checked further after retrieval.

Specified by:

getActiveCreditMemoDocumentNumbersForPurchaseOrder in interface CreditMemoDao

Returns: