org.kuali.kfs.module.ar.document.service
Interface CashControlDocumentService

All Known Implementing Classes:

CashControlDocumentServiceImpl

public interface CashControlDocumentService

Method Summary

void	addNewCashControlDetail(String descritpion, CashControlDocument cashControlDocument, CashControlDetail cashControlDetail) This method add a new cash control detail to the cash control document
PaymentApplicationDocument	createAndSavePaymentApplicationDocument(String description, CashControlDocument cashControlDocument, CashControlDetail cashControlDetail) This method creates a new PaymentApplicationDocument
boolean	createBankOffsetGLPEs(CashControlDocument cashControlDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Creates bank offset GLPEs for the cash control document
boolean	createCashReceiptGLPEs(CashControlDocument cashControlDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) This method creates the GLPEs with document type CR
boolean	createDistributionOfIncomeAndExpenseGLPEs(CashControlDocument cashControlDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) This method creates the GLPEs with document type DI
boolean	createGeneralErrorCorrectionGLPEs(CashControlDocument cashControlDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) This method creates the GLPEs with document type GEC
String	getLockboxNumber(CashControlDocument cashControlDocument) This method gets the lockbox number for the current CashControl document
void	saveGLPEs(CashControlDocument cashControlDocument) This method saves CashControl document GLPEs in the database

Method Detail

addNewCashControlDetail

void addNewCashControlDetail(String descritpion,
                             CashControlDocument cashControlDocument,
                             CashControlDetail cashControlDetail)
                             throws org.kuali.rice.kew.exception.WorkflowException

This method add a new cash control detail to the cash control document

Parameters:

descritpion - the description tells whether the detail was added by cash controo doc or by lockbox

cashControlDocument - the cash control document

cashControlDetail - the cash control detail to be added

Throws:

org.kuali.rice.kew.exception.WorkflowException

createAndSavePaymentApplicationDocument

PaymentApplicationDocument createAndSavePaymentApplicationDocument(String description,
                                                                   CashControlDocument cashControlDocument,
                                                                   CashControlDetail cashControlDetail)
                                                                   throws org.kuali.rice.kew.exception.WorkflowException

This method creates a new PaymentApplicationDocument

Parameters:

description - the description tells whether the detail was added by cash controo doc or by lockbox

cashControlDocument - the cash control document

cashControlDetail - the cash control detail

Returns:

true if all application document have been approved, false otherwise

Throws:

org.kuali.rice.kew.exception.WorkflowException

createCashReceiptGLPEs

boolean createCashReceiptGLPEs(CashControlDocument cashControlDocument,
                               GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

This method creates the GLPEs with document type CR

Parameters:

cashControlDocument -

sequenceHelper -

Returns:

true if glpes successfuly created false otherwise

createDistributionOfIncomeAndExpenseGLPEs

boolean createDistributionOfIncomeAndExpenseGLPEs(CashControlDocument cashControlDocument,
                                                  GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

This method creates the GLPEs with document type DI

Parameters:

cashControlDocument -

sequenceHelper -

Returns:

true if glpes successfuly created false otherwise

createGeneralErrorCorrectionGLPEs

boolean createGeneralErrorCorrectionGLPEs(CashControlDocument cashControlDocument,
                                          GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

This method creates the GLPEs with document type GEC

Parameters:

cashControlDocument -

sequenceHelper -

Returns:

true if glpes successfuly created false otherwise

saveGLPEs

void saveGLPEs(CashControlDocument cashControlDocument)

This method saves CashControl document GLPEs in the database

Parameters:

cashControlDocument -

getLockboxNumber

String getLockboxNumber(CashControlDocument cashControlDocument)

This method gets the lockbox number for the current CashControl document

Returns:

the lockbox number

createBankOffsetGLPEs

boolean createBankOffsetGLPEs(CashControlDocument cashControlDocument,
                              GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Creates bank offset GLPEs for the cash control document

Parameters:

cashControlDocument - the document to create cash control GLPEs for

sequenceHelper - the sequence helper which will sequence the new GLPEs

Returns:

true if the new bank offset GLPEs were created successfully, false otherwise