org.kuali.kfs.module.purap.document.dataaccess
Interface CreditMemoDao

All Known Implementing Classes:

CreditMemoDaoOjb

public interface CreditMemoDao

Credit Memo DAO Interface. Defines DB access methods that a CreditMemoDaoImpl must implement.

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.

Method Detail

getCreditMemosToExtract

Iterator<VendorCreditMemoDocument> getCreditMemosToExtract(String chartCode)

Get all the credit memos that need to be extracted

Parameters:

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

Returns:

- Iterator of credit memos

getCreditMemosToExtractByVendor

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

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

Parameters:

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

vendorHeaderGeneratedIdentifier -

vendorDetailAssignedIdentifier -

Returns:

- Iterator of credit memos

duplicateExists

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. This method accepts the three values as arguments, and returns a boolean, describing whether a duplicate exists in the system or not.

Parameters:

vendorNumberHeaderId - - vendor number header id

vendorNumber - - the composite two-part vendorNumber (headerId-detailId)

creditMemoNumber - - the vendor-supplied creditMemoNumber

Returns:

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

duplicateExists

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. This method accepts the values as arguments, and returns a boolean, describing whether a duplicate exists in the system or not.

Parameters:

vendorNumberHeaderId -

vendorNumberDetailId -

date - - date of transaction

amount - - amount of transaction

Returns:

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

getDocumentNumberByCreditMemoId

String getDocumentNumberByCreditMemoId(Integer id)

This method returns a credit memo document number by id.

Parameters:

id - - credit memo id

Returns:

- document number

getActiveCreditMemoDocumentNumbersForPurchaseOrder

List<String> getActiveCreditMemoDocumentNumbersForPurchaseOrder(Integer purchaseOrderId)

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.

Parameters:

purchaseOrderId -

Returns: