org.kuali.kfs.fp.document.service.impl
Class CashManagementServiceImpl

java.lang.Object
  org.kuali.kfs.fp.document.service.impl.CashManagementServiceImpl

All Implemented Interfaces:

CashManagementService

@Transactional
public class CashManagementServiceImpl
extends Object
implements CashManagementService

This is the default implementation of the CashManagementService interface.

Constructor Summary

CashManagementServiceImpl()

Method Summary

void	addDeposit(CashManagementDocument cashManagementDoc, String depositTicketNumber, Bank bank, List selectedCashReceipts, List selectedCashieringChecks, boolean isFinalDeposit) This method adds a new deposit to a the given CashManagementDocument.
boolean	allowDocumentCancellation(CashManagementDocument cmDoc) This method determines if a document can be cancelled, by reviewing a set of criteria: - do any cash receipts exist in this document? - do any cashiering checks exist in this document? - do any cash details exist in this document? If any of these questions comes back as true, then the document cannot be canceled.
boolean	allVerifiedCashReceiptsAreDeposited(CashManagementDocument cmDoc) This method verifies that all cash receipts for the document are deposited.
void	applyCashieringTransaction(CashManagementDocument cmDoc) This method applies the cashiering transaction to the given CashManagementDocument.
protected Deposit	buildDeposit(CashManagementDocument cashManagementDoc, String depositTypeCode, String depositTicketNumber, Bank bank, List<CashReceiptDocument> selectedCashReceipts, List selectedCashieringChecks) This method builds a new deposit object from the parameters provided.
org.kuali.rice.kns.util.KualiDecimal	calculateDepositedCheckTotal(String documentNumber) Total up the amounts of all checks so far deposited as part of the given cash management document.
org.kuali.rice.kns.util.KualiDecimal	calculateUndepositedCheckTotal(String documentNumber) Calculates the total amount of all the undeposited checks for a cash management document.
void	cancelCashManagementDocument(CashManagementDocument cmDoc) This method cancels a cash management document, effectively nullifying all values and attributes associated with the document.
void	cancelDeposit(Deposit deposit) This method cancels a given deposit.
protected void	completeNewItemInProcess(CashieringTransaction trans) This method completes the new item in process by setting the item remaining amount equal to the item amount.
CashManagementDocument	createCashManagementDocument(String campusCode, String docDescription, String annotation) This method creates a new cash management document and sets the provided values as attributes to the document.
void	createNewCashDetails(CashManagementDocument cmDoc, String cashieringSource) This method creates new cumulative currency and coin details for the document given.
protected boolean	existCashDetails(CashManagementDocument cmDoc) This method determines if any populated currency or coin details exist for the given document.
protected boolean	existCashieringChecks(CashManagementDocument cmDoc) This method determines if cashiering checks exist for the cash management document.
protected boolean	existCashReceipts(CashManagementDocument cmDoc) This method determines if any verified, interim, or final cash receipts currently exist.
void	finalizeCashManagementDocument(CashManagementDocument cmDoc) This method performs the necessary steps to finalize a cash management document.
protected void	finalizeCashReceiptsForDeposit(Deposit deposit) This method switches cash receipts to "final" status as opposed to "interim" status.
void	finalizeLastInterimDeposit(CashManagementDocument cmDoc) This method turns the last interim deposit into the final deposit and locks the cash drawer.
CoinDetail	generateMasterCoinDetail(CashManagementDocument cmDoc) This method generates a master coin detail for the cash management document given.
CurrencyDetail	generateMasterCurrencyDetail(CashManagementDocument cmDoc) This method generates a master currency detail for the cash management document given.
org.kuali.rice.kns.service.BusinessObjectService	getBusinessObjectService() Getter for retrieving an instance of the BusinessObjectService attribute.
Map<Class,Object>	getCashDetailsForFinalDeposit(String documentNumber) This method retrieves the cash details for the final deposit object.
CashDrawerService	getCashDrawerService() Getter for retrieving an instance of the CashDrawerService attribute.
CashManagementDao	getCashManagementDao() Gets the cashManagementDao attribute.
CashManagementDocument	getCashManagementDocumentForCashReceiptId(String documentId) If a CMD is found that is associated with the CR document, then that CMD is returned; otherwise null is returned.
org.kuali.rice.kns.service.DataDictionaryService	getDataDictionaryService()
org.kuali.rice.kns.service.DateTimeService	getDateTimeService() Gets the dateTimeService attribute.
org.kuali.rice.kns.service.DocumentService	getDocumentService() Gets the documentService attribute.
List<CashieringItemInProcess>	getOpenItemsInProcess(CashManagementDocument cmDoc) This method retrieves a collection of open CashieringItemInProcess objects from the cash management document given and returns that collection.
List<CashieringItemInProcess>	getRecentlyClosedItemsInProcess(CashManagementDocument cmDoc) This method retrieves a collection of recently closed CashieringItemInProcess objects from the cash management document given and returns the collection.
protected Map<Integer,Check>	getUndepositedChecksAsMap(CashManagementDocument cmDoc) This method returns all undeposited checks as a map with the key of each value in the map equal to the sequence id of the corresponding check.
void	populateCashDetailsForDeposit(CashManagementDocument cmDoc) Populates the currency and coin detail for final deposits by setting the deposited currency or coin amount equal to the associated cashiering record currency or coin amount.
List<CashReceiptDocument>	retrieveCashReceipts(Deposit deposit) This method returns a collection of cash receipts associated with the deposit given.
protected void	saveChecks(CashManagementDocument cmDoc) This method retrieves all the checks for the given document and persists them.
protected void	saveExisingItemsInProcess(CashManagementDocument cmDoc, CashieringTransaction trans) This method checks the cashiering transaction to see if any open items in process were at least partially paid back; it then saves the changes.
protected void	saveMoneyInCash(CashManagementDocument cmDoc, CashieringTransaction trans) This method retrieves the amount of cash in the "money in" portion of the transaction and saves it to the cash management document.
protected void	saveMoneyOutCash(CashManagementDocument cmDoc, CashieringTransaction trans) This method retrieves the amount of cash in the "money out" portion of the transaction and saves it to the cash management document.
protected void	saveNewItemInProcess(CashManagementDocument cmDoc, CashieringTransaction trans) This methods checks if data was actually entered for the new item in process; if so, it saves that item in process.
List<Check>	selectCashieringChecksForDeposit(String documentNumber, Integer depositLineNumber) This method retrieves the collection of cashiering checks associated with a given deposit.
List<Check>	selectDepositedCashieringChecks(String documentNumber) This method retrieves a collection of all deposited checks associated with the given document.
Integer	selectNextAvailableCheckLineNumber(String documentNumber) This method retrieves the next available check line number from the document provided.
List<Check>	selectUndepositedCashieringChecks(String documentNumber) This method retrieves the collection of undeposited cashiering checks associated with the document given.
void	setBusinessObjectService(org.kuali.rice.kns.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setCashDrawerService(CashDrawerService cashDrawerService) Sets the cashDrawerService attribute value.
void	setCashManagementDao(CashManagementDao cashManagementDao) Sets the cashManagementDao attribute value.
void	setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService) Sets the data dictionary service implementation
void	setDateTimeService(org.kuali.rice.kns.service.DateTimeService dateTimeService) Sets the dateTimeService attribute value.
void	setDocumentService(org.kuali.rice.kns.service.DocumentService documentService) Sets the documentService attribute value.
protected void	transferChecksToCashManagementDocument(CashManagementDocument cmDoc, CashieringTransaction trans) This method retrieves the checks from the transaction and adds them to the cash management document.
protected void	updateCashDrawer(CashDrawer drawer, CashieringTransaction trans) This method puts money from the "money in" portion of the transaction into the cash drawer, and takes money from the "money out" portion of the cash drawer out.
protected void	validateDepositParams(CashManagementDocument cashManagementDoc, Bank bank, List<CashReceiptDocument> selectedCashReceipts) Validates the given Deposit parameters, throwing various (runtime) exceptions if errors exist.
boolean	verifyCashReceiptIsDeposited(CashManagementDocument cmDoc, CashReceiptDocument crDoc) Verifies if a given cash receipt is deposited as part of the given cash management document.

Methods inherited from class java.lang.Object

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

Constructor Detail

CashManagementServiceImpl

public CashManagementServiceImpl()

Method Detail

getCashManagementDocumentForCashReceiptId

public CashManagementDocument getCashManagementDocumentForCashReceiptId(String documentId)

If a CMD is found that is associated with the CR document, then that CMD is returned; otherwise null is returned. Currently the relationships are:

• (CashReceipt to CashReceiptHeader) is (1 to 1)
• (CashReceiptHeader to DepositCashReceiptControl) is (1 to 1)
• (DepositCashReceiptControl to Deposit) is (many to 1)
• (Deposit to CashManagementDocument) is (many to 1)

Specified by:

getCashManagementDocumentForCashReceiptId in interface CashManagementService

Parameters:

documentId - The id of the cash receipt document linked to the cash management document.

Returns:

An instance of a CashManagementDocument matching the provided search criteria, or null if no value is found.

See Also:

CashManagementService.getCashManagementDocumentForCashReceiptId(java.lang.String)

createCashManagementDocument

public CashManagementDocument createCashManagementDocument(String campusCode,
                                                           String docDescription,
                                                           String annotation)

This method creates a new cash management document and sets the provided values as attributes to the document. The steps followed to create a new cash management document are as follows:

• Find the drawer for the campus code given.
• Make sure the drawer is closed, force the drawer closed if it is not already closed.
• Create the cash management document, set the provided values to the document and link it to the cash drawer

If the campusCode or docDescription values are null, an IllegalArgumentException will be thrown. TODO - annotation is not used or set at all in this method, remove it if appropriate.

Specified by:

createCashManagementDocument in interface CashManagementService

Parameters:

campusCode - The campus code of the cash drawer.

docDescription - The document description to be set on the new cash management document.

annotation -

Returns:

A new instance of a CashManagementDocument (not persisted).

See Also:

CashManagementService.createCashManagementDocument(java.lang.String, java.lang.String, java.lang.String)

createNewCashDetails

public void createNewCashDetails(CashManagementDocument cmDoc,
                                 String cashieringSource)

This method creates new cumulative currency and coin details for the document given.

Specified by:

createNewCashDetails in interface CashManagementService

Parameters:

cmDoc - The cash management document the cumulative details will be associated with.

cashieringSource - The cashiering record source for the new details.

addDeposit

public void addDeposit(CashManagementDocument cashManagementDoc,
                       String depositTicketNumber,
                       Bank bank,
                       List selectedCashReceipts,
                       List selectedCashieringChecks,
                       boolean isFinalDeposit)

This method adds a new deposit to a the given CashManagementDocument.
The following steps go into adding a deposit to a cash management document.

• The given deposit parameters are validated.
• The corresponding cash drawer is locked
• The given cashiering check records are turned into check records
• The new deposit is created
• The deposit is added to the cash management document and persisted
• The list of cash receipts are associated with the new deposit
• The deposit is saved again to ensure all links and attributes of the deposit are set appropriately and persisted
• The drawer is unlocked

  Specified by:

  addDeposit in interface CashManagementService

  Parameters:

  cashManagementDoc - The document to have the deposit added to.

  depositTicketNumber - The ticket number of the deposit being added.

  bankAccount - The bank account on the deposit.

  selectedCashReceipts - The collection of cash receipts associated with the new deposit.

  selectedCashieringChecks - The collection of checks associated with the new deposit.

  isFinalDeposit - A flag used to identify if a deposit is the final deposit to be added to a cash management document.

  See Also:

  org.kuali.kfs.fp.document.service.CashManagementService#addInterimDeposit(org.kuali.kfs.fp.document.CashManagementDocument, java.lang.String, org.kuali.kfs.fp.businessobject.BankAccount, java.util.List)

validateDepositParams

protected void validateDepositParams(CashManagementDocument cashManagementDoc,
                                     Bank bank,
                                     List<CashReceiptDocument> selectedCashReceipts)

Validates the given Deposit parameters, throwing various (runtime) exceptions if errors exist.

Parameters:

cashManagementDoc - The document the deposit will be added to.

bank - The bank account of the deposit being added.

selectedCashReceipts - The collection of cash receipts associated with the new deposit.

buildDeposit

protected Deposit buildDeposit(CashManagementDocument cashManagementDoc,
                               String depositTypeCode,
                               String depositTicketNumber,
                               Bank bank,
                               List<CashReceiptDocument> selectedCashReceipts,
                               List selectedCashieringChecks)

This method builds a new deposit object from the parameters provided.

Parameters:

cashManagementDoc - The cash management document the deposit will be added to.

depositTypeCode - The type code associated with the deposit.

depositTicketNumber - The deposit ticket number to be set on the deposit object.

bank - The bank account of the deposit.

selectedCashReceipts - The cash receipts that make up the deposit.

selectedCashieringChecks - The cashiering checks that make up the deposit.

Returns:

A new instance of a deposit generated from all the parameters provided.

getUndepositedChecksAsMap

protected Map<Integer,Check> getUndepositedChecksAsMap(CashManagementDocument cmDoc)

This method returns all undeposited checks as a map with the key of each value in the map equal to the sequence id of the corresponding check.

Parameters:

cmDoc - The cash management doc to find undeposited checks for.

Returns:

A map of checks keyed on sequence id.

cancelCashManagementDocument

public void cancelCashManagementDocument(CashManagementDocument cmDoc)

This method cancels a cash management document, effectively nullifying all values and attributes associated with the document. Canceling a CashManagementDocument results in the following:

• Cancels (deletes) all deposits associated with the document.
• Recloses the drawer
• Remove all currency and coin records generated by the document.

NOTE: Method should only be called after the appropriate CashManagementDocumentRule has been successfully passed.

Specified by:

cancelCashManagementDocument in interface CashManagementService

Parameters:

cmDoc - The CashManagementDocument to be canceled.

See Also:

CashManagementService.cancelCashManagementDocument(org.kuali.kfs.fp.document.CashManagementDocument)

cancelDeposit

public void cancelDeposit(Deposit deposit)

This method cancels a given deposit. This equates to the following:

• Resetting all associated CashReceipts to a state of VERIFIED.
• Update all associated cashiering checks to a be un-deposited.
• Unlock the cash drawer if needed.
• Delete the deposit.

Specified by:

cancelDeposit in interface CashManagementService

See Also:

CashManagementService.cancelDeposit(org.kuali.kfs.fp.businessobject.Deposit)

finalizeCashManagementDocument

public void finalizeCashManagementDocument(CashManagementDocument cmDoc)

This method performs the necessary steps to finalize a cash management document. These steps include:

• Finalize all associated cash receipts.
• Generate the master currency and coin details and persist them.
• Update the CashManagementDocument status to APPROVED.

NOTE: Method should only be called after the appropriate CashManagementDocumentRule has been successfully passed

Specified by:

finalizeCashManagementDocument in interface CashManagementService

Parameters:

cmDoc - The CashManagementDocument to be finalized.

See Also:

CashManagementService.finalizeCashManagementDocument(org.kuali.kfs.fp.document.CashManagementDocument)

allVerifiedCashReceiptsAreDeposited

public boolean allVerifiedCashReceiptsAreDeposited(CashManagementDocument cmDoc)

This method verifies that all cash receipts for the document are deposited.

Specified by:

allVerifiedCashReceiptsAreDeposited in interface CashManagementService

Parameters:

cmDoc - The cash management document to verify.

Returns:

True if all CashReceipts are deposited, false otherwise.

retrieveCashReceipts

public List<CashReceiptDocument> retrieveCashReceipts(Deposit deposit)

This method returns a collection of cash receipts associated with the deposit given.

Specified by:

retrieveCashReceipts in interface CashManagementService

Parameters:

deposit - The deposit to retrieve all the cash receipts for.

Returns:

A collection of cash receipts associated with the deposit given.

See Also:

CashManagementService.retrieveCashReceipts(org.kuali.kfs.fp.businessobject.Deposit)

verifyCashReceiptIsDeposited

public boolean verifyCashReceiptIsDeposited(CashManagementDocument cmDoc,
                                            CashReceiptDocument crDoc)

Verifies if a given cash receipt is deposited as part of the given cash management document.

Specified by:

verifyCashReceiptIsDeposited in interface CashManagementService

Parameters:

cmDoc - The cash management document to search through.

crDoc - The cash receipt to check the deposited status of.

Returns:

True if the given cash receipt document is deposited as part of the given cash management document, false otherwise.

finalizeLastInterimDeposit

public void finalizeLastInterimDeposit(CashManagementDocument cmDoc)

This method turns the last interim deposit into the final deposit and locks the cash drawer. A deposit is turned into a final deposit by updating the deposit type code.
NOTE: This method throws an IllegalStateException if a final deposit already exists for this document or if there are any undeposited cash receipts.

Specified by:

finalizeLastInterimDeposit in interface CashManagementService

Parameters:

cmDoc - The cash management document to take deposits from for finalization.

finalizeCashReceiptsForDeposit

protected void finalizeCashReceiptsForDeposit(Deposit deposit)

This method switches cash receipts to "final" status as opposed to "interim" status.

Parameters:

deposit - The deposit the cash receipts are associated with.

applyCashieringTransaction

public void applyCashieringTransaction(CashManagementDocument cmDoc)

This method applies the cashiering transaction to the given CashManagementDocument. This is accomplished by retrieving a CashieringTransactionRule object and running the appropriate methods to process the cashiering application rules.

Specified by:

applyCashieringTransaction in interface CashManagementService

Parameters:

cmDoc - The transaction to apply to the cash management document.

See Also:

org.kuali.kfs.fp.document.service.CashManagementService#applyCashieringTransaction(org.kuali.kfs.fp.document.CashManagementDocument, org.kuali.kfs.fp.businessobject.CashieringTransaction), org.kuali.kfs.fp.document.validation.impl.CashieringTransactionRule#processCashieringTransactionApplicationRules(CashManagementDocument)

updateCashDrawer

protected void updateCashDrawer(CashDrawer drawer,
                                CashieringTransaction trans)

This method puts money from the "money in" portion of the transaction into the cash drawer, and takes money from the "money out" portion of the cash drawer out.

Parameters:

drawer - The cash drawer to operate on.

trans - The transaction that is the operation.

completeNewItemInProcess

protected void completeNewItemInProcess(CashieringTransaction trans)

This method completes the new item in process by setting the item remaining amount equal to the item amount.

Parameters:

trans - The transaction being performed.

saveChecks

protected void saveChecks(CashManagementDocument cmDoc)

This method retrieves all the checks for the given document and persists them.

Parameters:

cmDoc - The cash management document the checks will be saved against.

transferChecksToCashManagementDocument

protected void transferChecksToCashManagementDocument(CashManagementDocument cmDoc,
                                                      CashieringTransaction trans)

This method retrieves the checks from the transaction and adds them to the cash management document.

Parameters:

cmDoc - The document the checks will be transferred to.

trans - The transaction the checks are associated with.

saveNewItemInProcess

protected void saveNewItemInProcess(CashManagementDocument cmDoc,
                                    CashieringTransaction trans)

This methods checks if data was actually entered for the new item in process; if so, it saves that item in process.

Parameters:

cmDoc - The cash management doc that the new item in process will be associated with.

trans - The cashiering transaction that created the new item in process.

saveExisingItemsInProcess

protected void saveExisingItemsInProcess(CashManagementDocument cmDoc,
                                         CashieringTransaction trans)

This method checks the cashiering transaction to see if any open items in process were at least partially paid back; it then saves the changes.

Parameters:

cmDoc - The cash management document that the items in process will be associated with

trans - The cashiering transaction the items in process are associated with.

saveMoneyInCash

protected void saveMoneyInCash(CashManagementDocument cmDoc,
                               CashieringTransaction trans)

This method retrieves the amount of cash in the "money in" portion of the transaction and saves it to the cash management document.

Parameters:

cmDoc - The cash management document that the cash will be saved to.

trans - The cashiering transaction the cash is currently associated with.

saveMoneyOutCash

protected void saveMoneyOutCash(CashManagementDocument cmDoc,
                                CashieringTransaction trans)

This method retrieves the amount of cash in the "money out" portion of the transaction and saves it to the cash management document.

Parameters:

cmDoc - The cash management document that the cash will be saved to.

trans - The cashiering transaction the cash is currently associated with.

getOpenItemsInProcess

public List<CashieringItemInProcess> getOpenItemsInProcess(CashManagementDocument cmDoc)

This method retrieves a collection of open CashieringItemInProcess objects from the cash management document given and returns that collection.

Specified by:

getOpenItemsInProcess in interface CashManagementService

Parameters:

cmDoc - The document the open items in process will be retrieved from.

Returns:

The collection of open items.

See Also:

CashManagementService.getOpenItemsInProcess(org.kuali.kfs.fp.document.CashManagementDocument)

getRecentlyClosedItemsInProcess

public List<CashieringItemInProcess> getRecentlyClosedItemsInProcess(CashManagementDocument cmDoc)

This method retrieves a collection of recently closed CashieringItemInProcess objects from the cash management document given and returns the collection.

Specified by:

getRecentlyClosedItemsInProcess in interface CashManagementService

Parameters:

cmDoc - The cash management document the recently closed items will be retrieved from.

Returns:

The collection of recently closed items.

See Also:

CashManagementService.getRecentlyClosedItemsInProcess(org.kuali.kfs.fp.document.CashManagementDocument)

generateMasterCoinDetail

public CoinDetail generateMasterCoinDetail(CashManagementDocument cmDoc)

This method generates a master coin detail for the cash management document given. A master coin detail is a CoinDetail that represents the result of all the money in and out of the cash drawer via the given cash management document. The following formula is used to perform this calculation:

• "coin detail for cash receipt - coin detail for deposits + coin detail for money in - coin detail for money out"

Specified by:

generateMasterCoinDetail in interface CashManagementService

Parameters:

cmDoc - The document the master coin detail will be generated from.

Returns:

The resulting coin detail.

See Also:

CashManagementService.generateMasterCoinDetail(org.kuali.kfs.fp.document.CashManagementDocument)

generateMasterCurrencyDetail

public CurrencyDetail generateMasterCurrencyDetail(CashManagementDocument cmDoc)

This method generates a master currency detail for the cash management document given. A master currency detail is a currencyDetail that represents the result of all the money in and out of the cash drawer via the given cash management document. The following formula is used to perform this calculation:

• "currency detail for cash receipt - currency detail for deposits + currency detail for money in - currency detail for money out"

Specified by:

generateMasterCurrencyDetail in interface CashManagementService

Parameters:

cmDoc - The document the master currency detail will be generated from.

Returns:

The resulting currency detail.

See Also:

CashManagementService.generateMasterCurrencyDetail(org.kuali.kfs.fp.document.CashManagementDocument)

populateCashDetailsForDeposit

public void populateCashDetailsForDeposit(CashManagementDocument cmDoc)

Populates the currency and coin detail for final deposits by setting the deposited currency or coin amount equal to the associated cashiering record currency or coin amount.

Specified by:

populateCashDetailsForDeposit in interface CashManagementService

Parameters:

cmDoc - The cash management document which has deposits to populate.

selectCashieringChecksForDeposit

public List<Check> selectCashieringChecksForDeposit(String documentNumber,
                                                    Integer depositLineNumber)

This method retrieves the collection of cashiering checks associated with a given deposit.

Specified by:

selectCashieringChecksForDeposit in interface CashManagementService

Parameters:

documentNumber - The id of the document to search for the deposit within.

depositLineNumber - The line number of the deposit to be found.

Returns:

A collection of checks for the deposit and document given.

See Also:

CashManagementService.selectCashieringChecksForDeposit(java.lang.String, java.lang.Integer)

selectUndepositedCashieringChecks

public List<Check> selectUndepositedCashieringChecks(String documentNumber)

This method retrieves the collection of undeposited cashiering checks associated with the document given.

Specified by:

selectUndepositedCashieringChecks in interface CashManagementService

Parameters:

documentNumber - The id of the document to search for the undeposited checks within.

Returns:

A collection of any undeposited checks for the document given.

See Also:

CashManagementService.selectUndepositedCashieringChecks(java.lang.String)

selectDepositedCashieringChecks

public List<Check> selectDepositedCashieringChecks(String documentNumber)

This method retrieves a collection of all deposited checks associated with the given document.

Specified by:

selectDepositedCashieringChecks in interface CashManagementService

Parameters:

documentNumber - The document to retrieve the deposited checks from.

Returns:

A collection of all deposited checks for the document given.

See Also:

CashManagementService.selectDepositedCashieringChecks(java.lang.String)

calculateDepositedCheckTotal

public org.kuali.rice.kns.util.KualiDecimal calculateDepositedCheckTotal(String documentNumber)

Total up the amounts of all checks so far deposited as part of the given cash management document.

Specified by:

calculateDepositedCheckTotal in interface CashManagementService

Parameters:

documentNumber - The id of a cash management document.

Returns:

The total amount of cashiering checks deposited so far as part of that document.

calculateUndepositedCheckTotal

public org.kuali.rice.kns.util.KualiDecimal calculateUndepositedCheckTotal(String documentNumber)

Calculates the total amount of all the undeposited checks for a cash management document.

Specified by:

calculateUndepositedCheckTotal in interface CashManagementService

Parameters:

documentNumber - The id of the cash management document to pull the undeposited checks from.

Returns:

The total amount of all undeposited checks for the document given.

See Also:

CashManagementService.calculateUndepositedCheckTotal(java.lang.String)

allowDocumentCancellation

public boolean allowDocumentCancellation(CashManagementDocument cmDoc)

This method determines if a document can be cancelled, by reviewing a set of criteria: - do any cash receipts exist in this document? - do any cashiering checks exist in this document? - do any cash details exist in this document? If any of these questions comes back as true, then the document cannot be canceled.

Specified by:

allowDocumentCancellation in interface CashManagementService

Parameters:

cmDoc - The document that would be canceled.

Returns:

True if the document can be canceled, false otherwise.

See Also:

CashManagementService.allowDocumentCancellation(org.kuali.kfs.fp.document.CashManagementDocument)

existCashReceipts

protected boolean existCashReceipts(CashManagementDocument cmDoc)

This method determines if any verified, interim, or final cash receipts currently exist.

Parameters:

cmDoc - The cash management document to find cash receipts associated with the campus of.

Returns:

True if there's some cash receipts that verified, interim, or final in this campus; false if otherwise.

existCashDetails

protected boolean existCashDetails(CashManagementDocument cmDoc)

This method determines if any populated currency or coin details exist for the given document.

Parameters:

cmDoc - A cash management document to find details.

Returns:

True if it finds populated currency or coin details, false if otherwise.

existCashieringChecks

protected boolean existCashieringChecks(CashManagementDocument cmDoc)

This method determines if cashiering checks exist for the cash management document.

Parameters:

cmDoc - The cash management document to test.

Returns:

True if it finds some checks, false if otherwise.

selectNextAvailableCheckLineNumber

public Integer selectNextAvailableCheckLineNumber(String documentNumber)

This method retrieves the next available check line number from the document provided.

Specified by:

selectNextAvailableCheckLineNumber in interface CashManagementService

Parameters:

documentNumber - The document to get the next check line number from.

Returns:

The next available check line number.

See Also:

CashManagementService.selectNextAvailableCheckLineNumber(java.lang.String)

getCashDetailsForFinalDeposit

public Map<Class,Object> getCashDetailsForFinalDeposit(String documentNumber)

This method retrieves the cash details for the final deposit object. The resulting map contains a CurrencyDetail and a CoinDetail object, both keyed by the class of detail they represent (ie. CurrencyDetail.class is the map key for the CurrencyDetail of the document).

Specified by:

getCashDetailsForFinalDeposit in interface CashManagementService

Parameters:

documentNumber - The document the details will be generated from.

Returns:

A map of the resulting cash details. This map is keyed by the detail class object.

See Also:

CashManagementService.getCashDetailsForFinalDeposit(java.lang.String)

getBusinessObjectService

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

Getter for retrieving an instance of the BusinessObjectService attribute.

Returns:

Current value of businessObjectService.

setBusinessObjectService

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

Sets the businessObjectService attribute value.

Parameters:

businessObjectService - The businessObjectService to set.

getCashDrawerService

public CashDrawerService getCashDrawerService()

Getter for retrieving an instance of the CashDrawerService attribute.

Returns:

Current value of cashDrawerService.

setCashDrawerService

public void setCashDrawerService(CashDrawerService cashDrawerService)

Sets the cashDrawerService attribute value.

Parameters:

cashDrawerService - The cashDrawerService to set.

getDocumentService

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

Gets the documentService attribute.

Returns:

Current value of documentService.

setDocumentService

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

Sets the documentService attribute value.

Parameters:

documentService -

getDateTimeService

public org.kuali.rice.kns.service.DateTimeService getDateTimeService()

Gets the dateTimeService attribute.

Returns:

Current value of dateTimeService.

setDateTimeService

public void setDateTimeService(org.kuali.rice.kns.service.DateTimeService dateTimeService)

Sets the dateTimeService attribute value.

Parameters:

dateTimeService - The dateTimeService to set.

getCashManagementDao

public CashManagementDao getCashManagementDao()

Gets the cashManagementDao attribute.

Returns:

Returns the cashManagementDao.

setCashManagementDao

public void setCashManagementDao(CashManagementDao cashManagementDao)

Sets the cashManagementDao attribute value.

Parameters:

cashManagementDao - The cashManagementDao to set.

getDataDictionaryService

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

Returns:

an implementation of the DataDictionaryService

setDataDictionaryService

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

Sets the data dictionary service implementation

Parameters:

dataDictionaryService - the implementation of the data dictionary service to use