| Method Summary |
|
| public void | addDeposit(CashManagementDocument cashManagementDoc, String depositTicketNumber, BankAccount bankAccount, List selectedCashReceipts, List selectedCashieringChecks, boolean isFinalDeposit)
This method adds a new deposit to a the given CashManagementDocument. |
| public boolean | allVerifiedCashReceiptsAreDeposited(CashManagementDocument cmDoc)
This method verifies that all cash receipts for the document are deposited.
Parameters:
cmDoc - The cash management document to verify. |
| 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.
Parameters:
cmDoc - The document that would be canceled. |
| public void | applyCashieringTransaction(CashManagementDocument cmDoc)
This method applies the cashiering transaction to the given CashManagementDocument. |
| public KualiDecimal | calculateDepositedCheckTotal(String documentNumber)
Total up the amounts of all checks so far deposited as part of the given cash management document.
Parameters:
documentNumber - The id of a cash management document. |
| public KualiDecimal | calculateUndepositedCheckTotal(String documentNumber)
Calculates the total amount of all the undeposited checks for a cash management document.
Parameters:
documentNumber - The id of the cash management document to pull the undeposited checks from. |
| public void | cancelCashManagementDocument(CashManagementDocument cmDoc)
This method cancels a cash management document, effectively nullifying all values and attributes associated with
the document. |
| public void | cancelDeposit(Deposit deposit)
This method cancels a given deposit. |
| public CashManagementDocument | createCashManagementDocument(String workgroupName, String docDescription, String annotation)
This method creates a new cash management document and sets the provided values as attributes to the document. |
| public void | createNewCashDetails(CashManagementDocument cmDoc, String cashieringSource)
This method creates new cumulative currency and coin details for the document given. |
| public void | finalizeCashManagementDocument(CashManagementDocument cmDoc)
This method performs the necessary steps to finalize a cash management document. |
| public void | finalizeLastInterimDeposit(CashManagementDocument cmDoc)
This method turns the last interim deposit into the final deposit and locks the cash drawer. |
| public CoinDetail | generateMasterCoinDetail(CashManagementDocument cmDoc)
This method generates a master coin detail for the cash management document given. |
| public CurrencyDetail | generateMasterCurrencyDetail(CashManagementDocument cmDoc)
This method generates a master currency detail for the cash management document given. |
| public BusinessObjectService | getBusinessObjectService()
Getter for retrieving an instance of the BusinessObjectService attribute. |
| public Map<Class, Object> | getCashDetailsForFinalDeposit(String documentNumber)
This method retrieves the cash details for the final deposit object. |
| public CashDrawerService | getCashDrawerService()
Getter for retrieving an instance of the CashDrawerService attribute. |
| public CashManagementDao | getCashManagementDao()
Gets the cashManagementDao attribute. |
| 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. |
| public DateTimeService | getDateTimeService()
Gets the dateTimeService attribute. |
| public DocumentService | getDocumentService()
Gets the documentService attribute. |
| 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.
Parameters:
cmDoc - The document the open items in process will be retrieved from. |
| 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. |
| 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. |
| public List | retrieveCashReceipts(Deposit deposit)
This method returns a collection of cash receipts associated with the deposit given.
Parameters:
deposit - The deposit to retrieve all the cash receipts for. |
| public List<Check> | selectCashieringChecksForDeposit(String documentNumber, Integer depositLineNumber)
This method retrieves the collection of cashiering checks associated with a given deposit.
Parameters:
documentNumber - The id of the document to search for the deposit within.
Parameters:
depositLineNumber - The line number of the deposit to be found. |
| public List<Check> | selectDepositedCashieringChecks(String documentNumber)
This method retrieves a collection of all deposited checks associated with the given document.
Parameters:
documentNumber - The document to retrieve the deposited checks from. |
| public Integer | selectNextAvailableCheckLineNumber(String documentNumber)
This method retrieves the next available check line number from the document provided.
Parameters:
documentNumber - The document to get the next check line number from. |
| public List<Check> | selectUndepositedCashieringChecks(String documentNumber)
This method retrieves the collection of undeposited cashiering checks associated with the document given.
Parameters:
documentNumber - The id of the document to search for the undeposited checks within. |
| public void | setBusinessObjectService(BusinessObjectService businessObjectService)
Sets the businessObjectService attribute value. |
| public void | setCashDrawerService(CashDrawerService cashDrawerService)
Sets the cashDrawerService attribute value. |
| public void | setCashManagementDao(CashManagementDao cashManagementDao)
Sets the cashManagementDao attribute value. |
| public void | setDateTimeService(DateTimeService dateTimeService)
Sets the dateTimeService attribute value. |
| public void | setDocumentService(DocumentService documentService)
Sets the documentService attribute value. |
| public boolean | verifyCashReceiptIsDeposited(CashManagementDocument cmDoc, CashReceiptDocument crDoc)
Verifies if a given cash receipt is deposited as part of the given cash management document.
Parameters:
cmDoc - The cash management document to search through.
Parameters:
crDoc - The cash receipt to check the deposited status of. |
