org.kuali.ole.select.document.service.impl

Class OleCreditMemoServiceImpl

java.lang.Object

org.kuali.ole.module.purap.document.service.impl.CreditMemoServiceImpl

org.kuali.ole.select.document.service.impl.OleCreditMemoServiceImpl

All Implemented Interfaces:

AccountsPayableDocumentSpecificService, CreditMemoService, OleCreditMemoService

@Transactional
public class OleCreditMemoServiceImpl
extends CreditMemoServiceImpl
implements OleCreditMemoService

Provides services to support the creation of a Credit Memo Document.

Constructor Summary

Constructors

Constructor and Description
OleCreditMemoServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	autoApproveCreditMemo(OleVendorCreditMemoDocument creditMemoDoc) NOTE: in the event of auto-approval failure, this method may throw a RuntimeException, indicating to Spring transactional management that the transaction should be rolled back.
void	calculateCreditMemo(VendorCreditMemoDocument cmDocument) Performs the credit memo item extended price calculation.
void	calculateProrateItemSurcharge(OleVendorCreditMemoDocument vendorCreditMemoDocument)
void	populateDocumentAfterInit(VendorCreditMemoDocument cmDocument) Populates the document from either the associated payment request document, purchase order document, or vendor detail based on the credit memo type.
void	populateDocumentFromInvoice(OleVendorCreditMemoDocument cmDocument, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)
protected void	populateDocumentFromPO(VendorCreditMemoDocument cmDocument, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList) Populate Credit Memo of type Purchase Order.
protected void	populateDocumentFromPreq(VendorCreditMemoDocument cmDocument, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList) Populate Credit Memo of type Payment Request.
protected void	populateDocumentFromVendor(VendorCreditMemoDocument cmDocument) Populate Credit Memo of type Vendor.
void	populateItemLinesFromInvoice(OleInvoiceDocument invoiceDocument, OleVendorCreditMemoDocument cmDocument, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList) Populates the credit memo items from the payment request items.
protected void	populateItemLinesFromPO(VendorCreditMemoDocument cmDocument, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList) Populates the credit memo items from the payment request items.
protected void	populateItemLinesFromPreq(VendorCreditMemoDocument cmDocument, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList) Populates the credit memo items from the payment request items.
void	setAccountsPayableService(AccountsPayableService accountsPayableService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setOleInvoiceService(OleInvoiceService oleInvoiceService)
void	setOlePaymentRequestService(OlePaymentRequestService olePaymentRequestService)
void	setOlePurapAccountingService(OlePurapAccountingService olePurapAccountingService)
void	setOlePurchaseOrderService(OlePurchaseOrderService olePurchaseOrderService)
void	setPurapAccountingService(PurapAccountingService purapAccountingService)
void	setPurapService(PurapService purapService)
void	setVendorService(VendorService vendorService)

Methods inherited from class org.kuali.ole.module.purap.document.service.impl.CreditMemoServiceImpl

addHoldOnCreditMemo, cancelExtractedCreditMemo, creditMemoDuplicateMessages, generateGLEntriesCreateAccountsPayableDocument, getCreditMemoByDocumentNumber, getCreditMemoDocumentById, getCreditMemosToExtract, getCreditMemosToExtractByVendor, getPersonForCancel, getPOInvoicedItems, getVendorsOnCreditMemosToExtract, hasActiveCreditMemosForPurchaseOrder, logAndThrowRuntimeException, logAndThrowRuntimeException, markPaid, poItemEligibleForAp, populateAndSaveCreditMemo, populateDocumentDescription, removeHoldOnCreditMemo, reopenClosedPO, resetExtractedCreditMemo, setConfigurationService, setCreditMemoDao, setDataDictionaryService, setNoteService, setPaymentRequestService, setPurapGeneralLedgerService, setPurchaseOrderService, setWorkflowDocumentService, shouldPurchaseOrderBeReversed, takePurchaseOrderCancelAction, updateStatusByNode, updateStatusByNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.ole.module.purap.document.service.CreditMemoService

addHoldOnCreditMemo, cancelExtractedCreditMemo, creditMemoDuplicateMessages, getCreditMemoByDocumentNumber, getCreditMemoDocumentById, getCreditMemosToExtract, getCreditMemosToExtractByVendor, getPOInvoicedItems, getVendorsOnCreditMemosToExtract, hasActiveCreditMemosForPurchaseOrder, markPaid, populateAndSaveCreditMemo, removeHoldOnCreditMemo, reopenClosedPO, resetExtractedCreditMemo

Methods inherited from interface org.kuali.ole.module.purap.document.service.AccountsPayableDocumentSpecificService

generateGLEntriesCreateAccountsPayableDocument, getPersonForCancel, poItemEligibleForAp, shouldPurchaseOrderBeReversed, takePurchaseOrderCancelAction, updateStatusByNode

Constructor Detail

OleCreditMemoServiceImpl

public OleCreditMemoServiceImpl()

Method Detail

setOlePurchaseOrderService

public void setOlePurchaseOrderService(OlePurchaseOrderService olePurchaseOrderService)

setVendorService

public void setVendorService(VendorService vendorService)

Overrides:

setVendorService in class CreditMemoServiceImpl

setOlePaymentRequestService

public void setOlePaymentRequestService(OlePaymentRequestService olePaymentRequestService)

setPurapAccountingService

public void setPurapAccountingService(PurapAccountingService purapAccountingService)

Overrides:

setPurapAccountingService in class CreditMemoServiceImpl

setPurapService

public void setPurapService(PurapService purapService)

Overrides:

setPurapService in class CreditMemoServiceImpl

setOleInvoiceService

public void setOleInvoiceService(OleInvoiceService oleInvoiceService)

setAccountsPayableService

public void setAccountsPayableService(AccountsPayableService accountsPayableService)

Overrides:

setAccountsPayableService in class CreditMemoServiceImpl

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

Overrides:

setDocumentService in class CreditMemoServiceImpl

setOlePurapAccountingService

public void setOlePurapAccountingService(OlePurapAccountingService olePurapAccountingService)

calculateCreditMemo

public void calculateCreditMemo(VendorCreditMemoDocument cmDocument)

Description copied from interface: CreditMemoService

Performs the credit memo item extended price calculation.

Specified by:

calculateCreditMemo in interface CreditMemoService

Overrides:

calculateCreditMemo in class CreditMemoServiceImpl

Parameters:

cmDocument - - credit memo document to calculate.

See Also:

calculateCreditMemo(org.kuali.ole.module.purap.document.VendorCreditMemoDocument)

calculateProrateItemSurcharge

public void calculateProrateItemSurcharge(OleVendorCreditMemoDocument vendorCreditMemoDocument)

populateItemLinesFromPreq

protected void populateItemLinesFromPreq(VendorCreditMemoDocument cmDocument,
                             HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)

Populates the credit memo items from the payment request items.

Overrides:

populateItemLinesFromPreq in class CreditMemoServiceImpl

Parameters:

cmDocument - - Credit Memo Document to Populate

populateDocumentFromPreq

protected void populateDocumentFromPreq(VendorCreditMemoDocument cmDocument,
                            HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)

Populate Credit Memo of type Payment Request.

Overrides:

populateDocumentFromPreq in class CreditMemoServiceImpl

Parameters:

cmDocument - - Credit Memo Document to Populate

populateDocumentFromPO

protected void populateDocumentFromPO(VendorCreditMemoDocument cmDocument,
                          HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)

Description copied from class: CreditMemoServiceImpl

Populate Credit Memo of type Purchase Order.

Overrides:

populateDocumentFromPO in class CreditMemoServiceImpl

Parameters:

cmDocument - - Credit Memo Document to Populate

populateItemLinesFromPO

protected void populateItemLinesFromPO(VendorCreditMemoDocument cmDocument,
                           HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)

Populates the credit memo items from the payment request items.

Overrides:

populateItemLinesFromPO in class CreditMemoServiceImpl

Parameters:

cmDocument - - Credit Memo Document to Populate

populateDocumentFromVendor

protected void populateDocumentFromVendor(VendorCreditMemoDocument cmDocument)

Description copied from class: CreditMemoServiceImpl

Populate Credit Memo of type Vendor.

Overrides:

populateDocumentFromVendor in class CreditMemoServiceImpl

Parameters:

cmDocument - - Credit Memo Document to Populate

populateDocumentAfterInit

public void populateDocumentAfterInit(VendorCreditMemoDocument cmDocument)

Description copied from interface: CreditMemoService

Populates the document from either the associated payment request document, purchase order document, or vendor detail based on the credit memo type.

Specified by:

populateDocumentAfterInit in interface CreditMemoService

Overrides:

populateDocumentAfterInit in class CreditMemoServiceImpl

Parameters:

cmDocument - - Credit Memo Document to Populate

See Also:

populateDocumentAfterInit(org.kuali.ole.module.purap.document.CreditMemoDocument)

populateDocumentFromInvoice

public void populateDocumentFromInvoice(OleVendorCreditMemoDocument cmDocument,
                               HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)

Specified by:

populateDocumentFromInvoice in interface OleCreditMemoService

populateItemLinesFromInvoice

public void populateItemLinesFromInvoice(OleInvoiceDocument invoiceDocument,
                                OleVendorCreditMemoDocument cmDocument,
                                HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)

Populates the credit memo items from the payment request items.

Specified by:

populateItemLinesFromInvoice in interface OleCreditMemoService

Parameters:

cmDocument - - Credit Memo Document to Populate

autoApproveCreditMemo

public boolean autoApproveCreditMemo(OleVendorCreditMemoDocument creditMemoDoc)

NOTE: in the event of auto-approval failure, this method may throw a RuntimeException, indicating to Spring transactional management that the transaction should be rolled back.

Specified by:

autoApproveCreditMemo in interface OleCreditMemoService

See Also:

autoApproveCreditMemo(org.kuali.ole.module.purap.document.PaymentRequestDocument, org.kuali.rice.core.api.util.type.KualiDecimal)