| Method Summary |
|
| public void | addDeposit(CashManagementDocument cashManagementDoc, String depositTicketNumber, BankAccount bankAccount, List selectedCashReceipts, List selectedCashieringChecks, boolean isFinalDeposit)
Uses the given information to lock the appropriate CashDrawer, create a Deposit, and associate it with the given
CashManagementDocument and CashReceipts. |
| 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 whether or not the given cash management document can be canceled.
Parameters:
cmDoc - The cash management document to be canceled. |
| public void | applyCashieringTransaction(CashManagementDocument cmDoc)
Apply a cashiering transaction to a cash management document. |
| 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)
Total up the amounts of all cashiering checks not yet deposited as part of the given cash management document.
Parameters:
documentNumber - The id of a cash management document. |
| public void | cancelCashManagementDocument(CashManagementDocument cmDoc)
Cancels the given CashManagementDocument, canceling the Deposits it contains and closing the CashDrawer associated with the
given verification unit. |
| public void | cancelDeposit(Deposit deposit)
|
| public CashManagementDocument | createCashManagementDocument(String workgroupName, String docDescription, String annotation)
Creates and returns a CashManagementDocument, opening the CashDrawer associated with the given verification unit. |
| public void | createNewCashDetails(CashManagementDocument cmDoc, String cashieringSource)
This method creates new cumulative currency and coin details for a document. |
| public void | finalizeCashManagementDocument(CashManagementDocument cmDoc)
Finalizes the given CashManagementDocument, updating the status of the CashReceipt documents in the Deposits it contains and
closing the CashDrawer associated with the given verification unit. |
| 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 generates the "master" coin detail record - a composite of all the coin detail activity that occurred to the cash drawer.
Parameters:
cmDoc - The cash management document to generate the master record for. |
| public CurrencyDetail | generateMasterCurrencyDetail(CashManagementDocument cmDoc)
Generates the master currency detail, which sounds bad, but which is really just okay.
A master currency detail is the composite effect of all the transactions of a cash
management document on a cash drawer.
Parameters:
cmDoc - The cash management document to generate the master record for. |
| public Map<Class, Object> | getCashDetailsForFinalDeposit(String documentNumber)
This returns the currency and coin details for the final deposit, in a map keyed on the detail class
This returns the currency and coin details for the final deposit, in a map keyed on the detail class.
Parameters:
documentNumber - The document number to find the final deposit cash details for. |
| public CashManagementDocument | getCashManagementDocumentForCashReceiptId(String documentId)
Retrieves a CashManagementDocument instance associated with the cash receipt id provided. |
| public List<CashieringItemInProcess> | getOpenItemsInProcess(CashManagementDocument cmDoc)
Retrieve the open cashiering items in process for the given cash management document.
Parameters:
cmDoc - The cash management document to retrieve the items in process for. |
| public List<CashieringItemInProcess> | getRecentlyClosedItemsInProcess(CashManagementDocument cmDoc)
Returns all items in process associated with this workgroup, closed within the past 30 days
Parameters:
cmDoc - The cash management document which is associated with the workgroup that the closed items in process would have also been associated with. |
| public void | populateCashDetailsForDeposit(CashManagementDocument cmDoc)
Grab the currency and coin detail for final deposits. |
| public List | retrieveCashReceipts(Deposit deposit)
Returns a List of all CashReceipts associated with the given Deposit.
Parameters:
deposit - The deposit the cash receipts will be retrieved from. |
| public List<Check> | selectCashieringChecksForDeposit(String documentNumber, Integer depositLineNumber)
Retrieves from the database all cashiering transaction checks deposited for a given deposit.
Parameters:
documentNumber - The document number of a cash management document that cashiering transaction checks have been deposited for.
Parameters:
depositLineNumber - The line number of the deposit to find checks deposited for. |
| public List<Check> | selectDepositedCashieringChecks(String documentNumber)
Retrieves from the database all deposited cashiering transaction checks associated with the given cash management document number.
Parameters:
documentNumber - The document number of a cash management document that cashiering transaction checks may be associated with. |
| public Integer | selectNextAvailableCheckLineNumber(String documentNumber)
Select the next available check line number for the given cash management document.
Parameters:
documentNumber - The document number of a cash management document. |
| public List<Check> | selectUndepositedCashieringChecks(String documentNumber)
Retrieves from the database any undeposited cashiering transaction checks associated with the given cash management document.
Parameters:
documentNumber - The document number of a cash management document that cashiering transaction checks may be associated with. |
| 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. |