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

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

All Implemented Interfaces:

CashControlDocumentService

public class CashControlDocumentServiceImpl
extends Object
implements CashControlDocumentService

Constructor Summary

CashControlDocumentServiceImpl()

Method Summary

void	addNewCashControlDetail(String description, CashControlDocument cashControlDocument, CashControlDetail cashControlDetail) This method add a new cash control detail to the cash control document
protected AccountingLine	buildAccountingLine(String accountNumber, String subAccountNumber, String objectCode, String subObjectCode, String chartOfAccountsCode, String debitOrCredit, org.kuali.rice.kns.util.KualiDecimal amount) This method creates an accounting line.
protected GeneralLedgerPendingEntry	createAndAddNewExplicitEntry(CashControlDocument cashControlDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, AccountingLine accountingLine, SystemOptions options, String documentType) This method creates and adds a new explicit glpe
protected boolean	createAndAddTheOffsetEntry(CashControlDocument cashControlDocument, GeneralLedgerPendingEntry explicitEntry, AccountingLine accountingLine, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) This method creates and adds an offset entry for the given explicit entry and accounting line.
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
AccountsReceivableDocumentHeaderService	getAccountsReceivableDocumentHeaderService() This method gets the accounts receivable header
org.kuali.rice.kns.service.BusinessObjectService	getBusinessObjectService() This method gets the business object service
ChartService	getChartService() This method gets the chart service
org.kuali.rice.kns.service.DataDictionaryService	getDataDictionaryService() Gets the dataDictionaryService attribute.
org.kuali.rice.kns.service.DocumentService	getDocumentService() This method gets the document service
GeneralLedgerPendingEntryService	getGlpeService() This method gets the glpe service
String	getLockboxNumber(CashControlDocument cashControlDocument) This method gets the lockbox number for the current CashControl document
OptionsService	getOptionsService() This method gets the option service
SystemInformationService	getSystemInformationService() This method gets the system information servcie
UniversityDateService	getUniversityDateService()
void	saveGLPEs(CashControlDocument cashControlDocument) This method saves CashControl document GLPEs in the database
void	setAccountsReceivableDocumentHeaderService(AccountsReceivableDocumentHeaderService accountsReceivableDocumentHeaderService) This method sets the accounts receivable header
void	setBusinessObjectService(org.kuali.rice.kns.service.BusinessObjectService businessObjectService) This method sets the business object service
void	setChartService(ChartService chartService) This method sets the chart service
void	setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService) Sets the dataDictionaryService attribute value.
void	setDocumentService(org.kuali.rice.kns.service.DocumentService documentService) This method sets the document service
void	setGlpeService(GeneralLedgerPendingEntryService glpeService) This method sets the glpe service
void	setOptionsService(OptionsService optionsService) This method sets the option service
void	setSystemInformationService(SystemInformationService systemInformationService) This method sets the system information service
void	setUniversityDateService(UniversityDateService universityDateService)

Methods inherited from class java.lang.Object

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

Constructor Detail

CashControlDocumentServiceImpl

public CashControlDocumentServiceImpl()

Method Detail

createAndSavePaymentApplicationDocument

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

Description copied from interface: CashControlDocumentService

This method creates a new PaymentApplicationDocument

Specified by:

createAndSavePaymentApplicationDocument in interface CashControlDocumentService

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

See Also:

CashControlDocumentService.createAndSavePaymentApplicationDocument(java.lang.String, org.kuali.kfs.module.ar.document.CashControlDocument, org.kuali.kfs.module.ar.businessobject.CashControlDetail)

addNewCashControlDetail

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

Description copied from interface: CashControlDocumentService

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

Specified by:

addNewCashControlDetail in interface CashControlDocumentService

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 to be added

Throws:

org.kuali.rice.kew.exception.WorkflowException

See Also:

CashControlDocumentService.addNewCashControlDetail(java.lang.String, org.kuali.kfs.module.ar.document.CashControlDocument, org.kuali.kfs.module.ar.businessobject.CashControlDetail)

saveGLPEs

public void saveGLPEs(CashControlDocument cashControlDocument)

Description copied from interface: CashControlDocumentService

This method saves CashControl document GLPEs in the database

Specified by:

saveGLPEs in interface CashControlDocumentService

See Also:

CashControlDocumentService.saveGLPEs(org.kuali.kfs.module.ar.document.CashControlDocument)

createCashReceiptGLPEs

public boolean createCashReceiptGLPEs(CashControlDocument cashControlDocument,
                                      GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Description copied from interface: CashControlDocumentService

This method creates the GLPEs with document type CR

Specified by:

createCashReceiptGLPEs in interface CashControlDocumentService

Returns:

true if glpes successfuly created false otherwise

See Also:

CashControlDocumentService.createCashReceiptGLPEs(org.kuali.kfs.module.ar.document.CashControlDocument, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

createBankOffsetGLPEs

public boolean createBankOffsetGLPEs(CashControlDocument cashControlDocument,
                                     GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Creates bank offset GLPEs for the cash control document

Specified by:

createBankOffsetGLPEs in interface CashControlDocumentService

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

createDistributionOfIncomeAndExpenseGLPEs

public boolean createDistributionOfIncomeAndExpenseGLPEs(CashControlDocument cashControlDocument,
                                                         GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Description copied from interface: CashControlDocumentService

This method creates the GLPEs with document type DI

Specified by:

createDistributionOfIncomeAndExpenseGLPEs in interface CashControlDocumentService

Returns:

true if glpes successfuly created false otherwise

See Also:

CashControlDocumentService.createDistributionOfIncomeAndExpenseGLPEs(org.kuali.kfs.module.ar.document.CashControlDocument, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

createGeneralErrorCorrectionGLPEs

public boolean createGeneralErrorCorrectionGLPEs(CashControlDocument cashControlDocument,
                                                 GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Description copied from interface: CashControlDocumentService

This method creates the GLPEs with document type GEC

Specified by:

createGeneralErrorCorrectionGLPEs in interface CashControlDocumentService

Returns:

true if glpes successfuly created false otherwise

See Also:

CashControlDocumentService.createGeneralErrorCorrectionGLPEs(org.kuali.kfs.module.ar.document.CashControlDocument, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

getLockboxNumber

public String getLockboxNumber(CashControlDocument cashControlDocument)

Description copied from interface: CashControlDocumentService

This method gets the lockbox number for the current CashControl document

Specified by:

getLockboxNumber in interface CashControlDocumentService

Returns:

the lockbox number

See Also:

CashControlDocumentService.getLockboxNumber(org.kuali.kfs.module.ar.document.CashControlDocument)

buildAccountingLine

protected AccountingLine buildAccountingLine(String accountNumber,
                                             String subAccountNumber,
                                             String objectCode,
                                             String subObjectCode,
                                             String chartOfAccountsCode,
                                             String debitOrCredit,
                                             org.kuali.rice.kns.util.KualiDecimal amount)

This method creates an accounting line.

Parameters:

systemInformation - System Information used to set accounting line data

debitOrCredit - Tells if it is debit or credit

amount - The amount

Returns:

The created accounting line

createAndAddNewExplicitEntry

protected GeneralLedgerPendingEntry createAndAddNewExplicitEntry(CashControlDocument cashControlDocument,
                                                                 GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                                                                 AccountingLine accountingLine,
                                                                 SystemOptions options,
                                                                 String documentType)

This method creates and adds a new explicit glpe

Parameters:

cashControlDocument - the cash control document

sequenceHelper - sequence helper

accountingLine - the accounting line based on which the glpe is created

options - the current year oprions

documentType - the document type to be associated with the glpe

createAndAddTheOffsetEntry

protected boolean createAndAddTheOffsetEntry(CashControlDocument cashControlDocument,
                                             GeneralLedgerPendingEntry explicitEntry,
                                             AccountingLine accountingLine,
                                             GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

This method creates and adds an offset entry for the given explicit entry and accounting line.

Parameters:

cashControlDocument - the cash control document

explicitEntry - the explicit entry for which we create the offset entry

accountingLine - the accounting line used to populate the offset entry

sequenceHelper - the sequence helper

Returns:

true if successfuly created and added, false otherwise

getSystemInformationService

public SystemInformationService getSystemInformationService()

This method gets the system information servcie

Returns:

the system information service

setSystemInformationService

public void setSystemInformationService(SystemInformationService systemInformationService)

This method sets the system information service

Parameters:

systemInformationService -

getChartService

public ChartService getChartService()

This method gets the chart service

Returns:

setChartService

public void setChartService(ChartService chartService)

This method sets the chart service

Parameters:

chartService -

getDataDictionaryService

public org.kuali.rice.kns.service.DataDictionaryService getDataDictionaryService()

Gets the dataDictionaryService attribute.

Returns:

Returns the dataDictionaryService.

setDataDictionaryService

public void setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService)

Sets the dataDictionaryService attribute value.

Parameters:

dataDictionaryService - The dataDictionaryService to set.

getGlpeService

public GeneralLedgerPendingEntryService getGlpeService()

This method gets the glpe service

Returns:

setGlpeService

public void setGlpeService(GeneralLedgerPendingEntryService glpeService)

This method sets the glpe service

Parameters:

glpeService -

getBusinessObjectService

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

This method gets the business object service

Returns:

the business object service

setBusinessObjectService

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

This method sets the business object service

Parameters:

businessObjectService -

getOptionsService

public OptionsService getOptionsService()

This method gets the option service

Returns:

the option service

setOptionsService

public void setOptionsService(OptionsService optionsService)

This method sets the option service

Parameters:

optionsService -

getAccountsReceivableDocumentHeaderService

public AccountsReceivableDocumentHeaderService getAccountsReceivableDocumentHeaderService()

This method gets the accounts receivable header

Returns:

the accounts receivable header

setAccountsReceivableDocumentHeaderService

public void setAccountsReceivableDocumentHeaderService(AccountsReceivableDocumentHeaderService accountsReceivableDocumentHeaderService)

This method sets the accounts receivable header

Parameters:

accountsReceivableDocumentHeaderService -

getDocumentService

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

This method gets the document service

Returns:

the document service

setDocumentService

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

This method sets the document service

Parameters:

documentService -

getUniversityDateService

public UniversityDateService getUniversityDateService()

setUniversityDateService

public void setUniversityDateService(UniversityDateService universityDateService)