org.kuali.kfs.module.ar.document.service.impl
Class PaymentApplicationDocumentServiceImpl

java.lang.Object
  org.kuali.kfs.module.ar.document.service.impl.PaymentApplicationDocumentServiceImpl

All Implemented Interfaces:

PaymentApplicationDocumentService

@Transactional
public class PaymentApplicationDocumentServiceImpl
extends Object
implements PaymentApplicationDocumentService

Constructor Summary

PaymentApplicationDocumentServiceImpl()

Method Summary

PaymentApplicationDocument	createAndSavePaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument)
InvoicePaidApplied	createInvoicePaidAppliedForInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail, PaymentApplicationDocument paymentApplicationDocument, Integer paidAppliedItemNumber) This method creates an invoice paid applied for the given customer invoice detail.
PaymentApplicationDocument	createInvoicePaidAppliedsForEntireInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument, PaymentApplicationDocument paymentApplicationDocument) Creates PaidApplieds for all the invoice lines on the passed in InvoiceDocument, on the passed in PaymentApplicationDocument.
PaymentApplicationDocument	createPaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument) This method is used in the lockbox process to create a PA document which is then auto-approved when the amount on the invoice matches the amount on the lockbox.
PaymentApplicationDocument	createSaveAndApprovePaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument, String approvalAnnotation, List workflowNotificationRecipients)
boolean	customerInvoiceDetailPairsWithInvoicePaidApplied(CustomerInvoiceDetail customerInvoiceDetail, InvoicePaidApplied invoicePaidApplied) This method returns true if invoicePaidApplied is the applied payment for the customer invoice detail based on document number and item/sequence number.
org.kuali.rice.kns.service.BusinessObjectService	getBusinessObjectService()
CashControlDetail	getCashControlDetailForPayAppDocNumber(String payAppDocNumber) Retrieves the CashControlDetail line associated with the passed-in PaymentApplication Document number.
CashControlDetail	getCashControlDetailForPaymentApplicationDocument(PaymentApplicationDocument document) Retrieves the CashControlDetail line associated with the passed-in PaymentApplication Document.
CashControlDocument	getCashControlDocumentForPayAppDocNumber(String paymentApplicationDocumentNumber) Retrieves the CashControlDocument associated with the passed-in PaymentApplication Document number.
CashControlDocument	getCashControlDocumentForPaymentApplicationDocument(PaymentApplicationDocument paymentApplicationDocument) Retrieves the CashControlDocument associated with the passed-in PaymentApplication Document.
org.kuali.rice.kns.service.DocumentService	getDocumentService()
NonAppliedHoldingService	getNonAppliedHoldingService()
org.kuali.rice.kns.util.KualiDecimal	getTotalAppliedAmountForPaymentApplicationDocument(PaymentApplicationDocument document)
org.kuali.rice.kns.util.KualiDecimal	getTotalUnappliedFundsForPaymentApplicationDocument(PaymentApplicationDocument document)
org.kuali.rice.kns.util.KualiDecimal	getTotalUnappliedFundsToBeAppliedForPaymentApplicationDocument(PaymentApplicationDocument document)
void	setBusinessObjectService(org.kuali.rice.kns.service.BusinessObjectService businessObjectService)
void	setCashControlDetailDao(CashControlDetailDao cashControlDetailDao)
void	setDocumentService(org.kuali.rice.kns.service.DocumentService documentService)
void	setInvoicePaidAppliedService(InvoicePaidAppliedService invoicePaidAppliedService)
void	setNonAppliedHoldingService(NonAppliedHoldingService nonAppliedHoldingService)
void	setUniversityDateService(UniversityDateService universityDateService)

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentApplicationDocumentServiceImpl

public PaymentApplicationDocumentServiceImpl()

Method Detail

createPaymentApplicationToMatchInvoice

public PaymentApplicationDocument createPaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument)
                                                                  throws org.kuali.rice.kew.exception.WorkflowException

Description copied from interface: PaymentApplicationDocumentService

This method is used in the lockbox process to create a PA document which is then auto-approved when the amount on the invoice matches the amount on the lockbox.

Specified by:

createPaymentApplicationToMatchInvoice in interface PaymentApplicationDocumentService

Parameters:

customerInvoiceDocument -

Returns:

Throws:

org.kuali.rice.kew.exception.WorkflowException

createAndSavePaymentApplicationToMatchInvoice

public PaymentApplicationDocument createAndSavePaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument)
                                                                         throws org.kuali.rice.kew.exception.WorkflowException

Specified by:

createAndSavePaymentApplicationToMatchInvoice in interface PaymentApplicationDocumentService

Parameters:

customerInvoiceDocument -

Returns:

Throws:

org.kuali.rice.kew.exception.WorkflowException

createSaveAndApprovePaymentApplicationToMatchInvoice

public PaymentApplicationDocument createSaveAndApprovePaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument,
                                                                                       String approvalAnnotation,
                                                                                       List workflowNotificationRecipients)
                                                                                throws org.kuali.rice.kew.exception.WorkflowException

Specified by:

createSaveAndApprovePaymentApplicationToMatchInvoice in interface PaymentApplicationDocumentService

Parameters:

customerInvoiceDocument -

approvalAnnotation -

workflowNotificationRecipients -

Returns:

Throws:

org.kuali.rice.kew.exception.WorkflowException

getTotalAppliedAmountForPaymentApplicationDocument

public org.kuali.rice.kns.util.KualiDecimal getTotalAppliedAmountForPaymentApplicationDocument(PaymentApplicationDocument document)

Parameters:

document -

Returns:

getTotalUnappliedFundsForPaymentApplicationDocument

public org.kuali.rice.kns.util.KualiDecimal getTotalUnappliedFundsForPaymentApplicationDocument(PaymentApplicationDocument document)

Parameters:

document -

Returns:

getTotalUnappliedFundsToBeAppliedForPaymentApplicationDocument

public org.kuali.rice.kns.util.KualiDecimal getTotalUnappliedFundsToBeAppliedForPaymentApplicationDocument(PaymentApplicationDocument document)

Parameters:

document -

Returns:

getCashControlDocumentForPaymentApplicationDocument

public CashControlDocument getCashControlDocumentForPaymentApplicationDocument(PaymentApplicationDocument paymentApplicationDocument)

Description copied from interface: PaymentApplicationDocumentService

Retrieves the CashControlDocument associated with the passed-in PaymentApplication Document.

Specified by:

getCashControlDocumentForPaymentApplicationDocument in interface PaymentApplicationDocumentService

Parameters:

paymentApplicationDocument - A valid PaymentApplication Document

Returns:

The associated CashControlDocument, if exists, or null if not.

See Also:

PaymentApplicationDocumentService.getCashControlDocumentForPaymentApplicationDocument(org.kuali.kfs.module.ar.document.PaymentApplicationDocument)

getCashControlDocumentForPayAppDocNumber

public CashControlDocument getCashControlDocumentForPayAppDocNumber(String paymentApplicationDocumentNumber)

Description copied from interface: PaymentApplicationDocumentService

Retrieves the CashControlDocument associated with the passed-in PaymentApplication Document number.

Specified by:

getCashControlDocumentForPayAppDocNumber in interface PaymentApplicationDocumentService

Parameters:

paymentApplicationDocumentNumber - A valid PaymentApplication Document number

Returns:

The associated CashControlDocument, if exists, or null if not.

See Also:

PaymentApplicationDocumentService.getCashControlDocumentForPayAppDocNumber(java.lang.String)

getCashControlDetailForPaymentApplicationDocument

public CashControlDetail getCashControlDetailForPaymentApplicationDocument(PaymentApplicationDocument document)

Description copied from interface: PaymentApplicationDocumentService

Retrieves the CashControlDetail line associated with the passed-in PaymentApplication Document.

Specified by:

getCashControlDetailForPaymentApplicationDocument in interface PaymentApplicationDocumentService

Parameters:

document - A valid PaymentApplication Document

Returns:

The associated CashControlDetail, if exists, or null if not.

See Also:

PaymentApplicationDocumentService.getCashControlDetailForPaymentApplicationDocument(org.kuali.kfs.module.ar.document.PaymentApplicationDocument)

getCashControlDetailForPayAppDocNumber

public CashControlDetail getCashControlDetailForPayAppDocNumber(String payAppDocNumber)

Description copied from interface: PaymentApplicationDocumentService

Retrieves the CashControlDetail line associated with the passed-in PaymentApplication Document number.

Specified by:

getCashControlDetailForPayAppDocNumber in interface PaymentApplicationDocumentService

Parameters:

payAppDocNumber - A valid PaymentApplication Document Number

Returns:

The associated CashControlDetail, if exists, or null if not.

See Also:

PaymentApplicationDocumentService.getCashControlDetailForPayAppDocNumber(java.lang.String)

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.kns.service.BusinessObjectService businessObjectService)

createInvoicePaidAppliedsForEntireInvoiceDocument

public PaymentApplicationDocument createInvoicePaidAppliedsForEntireInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument,
                                                                                    PaymentApplicationDocument paymentApplicationDocument)

Description copied from interface: PaymentApplicationDocumentService

Creates PaidApplieds for all the invoice lines on the passed in InvoiceDocument, on the passed in PaymentApplicationDocument. This method will overwrite any existing PaidApplieds on the document, it assumes an empty PayApp doc with no paidapplieds. This method does no checking to prevent over or under applying, it assumes that the documents have been setup such that it will work correctly. So if this method is used to over or under apply, then the resulting PaymentApplicationDocument will fail business rules validation.

Specified by:

createInvoicePaidAppliedsForEntireInvoiceDocument in interface PaymentApplicationDocumentService

Returns:

createInvoicePaidAppliedForInvoiceDetail

public InvoicePaidApplied createInvoicePaidAppliedForInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail,
                                                                   PaymentApplicationDocument paymentApplicationDocument,
                                                                   Integer paidAppliedItemNumber)

Description copied from interface: PaymentApplicationDocumentService

This method creates an invoice paid applied for the given customer invoice detail. This method assumes that no existing paidApplieds are already on the document.

Specified by:

createInvoicePaidAppliedForInvoiceDetail in interface PaymentApplicationDocumentService

Parameters:

customerInvoiceDetail - the customer invoice detail for which we want to create the invoice paid applied

Returns:

the created invoice paid applied if it did not exist, null otherwise

See Also:

org.kuali.kfs.module.ar.document.service.PaymentApplicationDocumentService#createInvoicePaidAppliedForInvoiceDetail(org.kuali.kfs.module.ar.businessobject.CustomerInvoiceDetail, org.kuali.rice.kns.util.KualiDecimal)

customerInvoiceDetailPairsWithInvoicePaidApplied

public boolean customerInvoiceDetailPairsWithInvoicePaidApplied(CustomerInvoiceDetail customerInvoiceDetail,
                                                                InvoicePaidApplied invoicePaidApplied)

Description copied from interface: PaymentApplicationDocumentService

This method returns true if invoicePaidApplied is the applied payment for the customer invoice detail based on document number and item/sequence number.

Specified by:

customerInvoiceDetailPairsWithInvoicePaidApplied in interface PaymentApplicationDocumentService

Returns:

See Also:

PaymentApplicationDocumentService.customerInvoiceDetailPairsWithInvoicePaidApplied(org.kuali.kfs.module.ar.businessobject.CustomerInvoiceDetail, org.kuali.kfs.module.ar.businessobject.InvoicePaidApplied)

getDocumentService

public org.kuali.rice.kns.service.DocumentService getDocumentService()

setDocumentService

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

setInvoicePaidAppliedService

public void setInvoicePaidAppliedService(InvoicePaidAppliedService invoicePaidAppliedService)

getBusinessObjectService

public org.kuali.rice.kns.service.BusinessObjectService getBusinessObjectService()

getNonAppliedHoldingService

public NonAppliedHoldingService getNonAppliedHoldingService()

setNonAppliedHoldingService

public void setNonAppliedHoldingService(NonAppliedHoldingService nonAppliedHoldingService)

setUniversityDateService

public void setUniversityDateService(UniversityDateService universityDateService)

setCashControlDetailDao

public void setCashControlDetailDao(CashControlDetailDao cashControlDetailDao)