Uses of Class
org.kuali.kfs.fp.document.CashManagementDocument

Packages that use CashManagementDocument

org.kuali.kfs.fp.businessobject
org.kuali.kfs.fp.document.service
org.kuali.kfs.fp.document.service.impl
org.kuali.kfs.fp.document.validation.impl
org.kuali.kfs.fp.document.web.struts

Uses of CashManagementDocument in org.kuali.kfs.fp.businessobject

Methods in org.kuali.kfs.fp.businessobject that return CashManagementDocument

CashManagementDocument

Deposit.getCashManagementDocument()

Methods in org.kuali.kfs.fp.businessobject with parameters of type CashManagementDocument

void	Deposit.setCashManagementDocument(CashManagementDocument cashManagementDocument) Sets the cashManagementDocument attribute value.

Uses of CashManagementDocument in org.kuali.kfs.fp.document.service

Methods in org.kuali.kfs.fp.document.service that return CashManagementDocument

CashManagementDocument	CashManagementService.createCashManagementDocument(String campusCode, String docDescription, String annotation) Creates and returns a CashManagementDocument, opening the CashDrawer associated with the given verification unit.
CashManagementDocument	CashManagementService.getCashManagementDocumentForCashReceiptId(String documentId) Retrieves a CashManagementDocument instance associated with the cash receipt id provided.

Methods in org.kuali.kfs.fp.document.service with parameters of type CashManagementDocument

void	CashManagementService.addDeposit(CashManagementDocument cashManagementDoc, String depositTicketNumber, Bank bank, 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.
boolean	CashManagementService.allowDocumentCancellation(CashManagementDocument cmDoc) This method determines whether or not the given cash management document can be canceled.
boolean	CashManagementService.allVerifiedCashReceiptsAreDeposited(CashManagementDocument cmDoc) This method verifies that all cash receipts for the document are deposited.
void	CashManagementService.applyCashieringTransaction(CashManagementDocument cmDoc) Apply a cashiering transaction to a cash management document.
void	CashManagementService.cancelCashManagementDocument(CashManagementDocument cmDoc) Cancels the given CashManagementDocument, canceling the Deposits it contains and closing the CashDrawer associated with the given verification unit.
void	CashManagementService.createNewCashDetails(CashManagementDocument cmDoc, String cashieringSource) This method creates new cumulative currency and coin details for a document.
void	CashManagementService.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.
void	CashManagementService.finalizeLastInterimDeposit(CashManagementDocument cmDoc) This method turns the last interim deposit into the final deposit and locks the cash drawer.
CoinDetail	CashManagementService.generateMasterCoinDetail(CashManagementDocument cmDoc) This generates the "master" coin detail record - a composite of all the coin detail activity that occurred to the cash drawer.
CurrencyDetail	CashManagementService.generateMasterCurrencyDetail(CashManagementDocument cmDoc) Generates the master currency detail, which sounds bad, but which is really just okay.
List<CashieringItemInProcess>	CashManagementService.getOpenItemsInProcess(CashManagementDocument cmDoc) Retrieve the open cashiering items in process for the given cash management document.
List<CashieringItemInProcess>	CashManagementService.getRecentlyClosedItemsInProcess(CashManagementDocument cmDoc) Returns all items in process associated with this workgroup, closed within the past 30 days
void	CashManagementService.populateCashDetailsForDeposit(CashManagementDocument cmDoc) Grab the currency and coin detail for final deposits.
boolean	CashManagementService.verifyCashReceiptIsDeposited(CashManagementDocument cmDoc, CashReceiptDocument crDoc) Verifies if a given cash receipt is deposited as part of the given cash management document.

Uses of CashManagementDocument in org.kuali.kfs.fp.document.service.impl

Methods in org.kuali.kfs.fp.document.service.impl that return CashManagementDocument

CashManagementDocument	CashManagementServiceImpl.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.
CashManagementDocument	CashManagementServiceImpl.getCashManagementDocumentForCashReceiptId(String documentId) If a CMD is found that is associated with the CR document, then that CMD is returned; otherwise null is returned.

Methods in org.kuali.kfs.fp.document.service.impl with parameters of type CashManagementDocument

void	CashManagementServiceImpl.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	CashManagementServiceImpl.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	CashManagementServiceImpl.allVerifiedCashReceiptsAreDeposited(CashManagementDocument cmDoc) This method verifies that all cash receipts for the document are deposited.
void	CashManagementServiceImpl.applyCashieringTransaction(CashManagementDocument cmDoc) This method applies the cashiering transaction to the given CashManagementDocument.
protected Deposit	CashManagementServiceImpl.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.
void	CashManagementServiceImpl.cancelCashManagementDocument(CashManagementDocument cmDoc) This method cancels a cash management document, effectively nullifying all values and attributes associated with the document.
void	CashManagementServiceImpl.createNewCashDetails(CashManagementDocument cmDoc, String cashieringSource) This method creates new cumulative currency and coin details for the document given.
protected boolean	CashManagementServiceImpl.existCashDetails(CashManagementDocument cmDoc) This method determines if any populated currency or coin details exist for the given document.
protected boolean	CashManagementServiceImpl.existCashieringChecks(CashManagementDocument cmDoc) This method determines if cashiering checks exist for the cash management document.
protected boolean	CashManagementServiceImpl.existCashReceipts(CashManagementDocument cmDoc) This method determines if any verified, interim, or final cash receipts currently exist.
void	CashManagementServiceImpl.finalizeCashManagementDocument(CashManagementDocument cmDoc) This method performs the necessary steps to finalize a cash management document.
void	CashManagementServiceImpl.finalizeLastInterimDeposit(CashManagementDocument cmDoc) This method turns the last interim deposit into the final deposit and locks the cash drawer.
CoinDetail	CashManagementServiceImpl.generateMasterCoinDetail(CashManagementDocument cmDoc) This method generates a master coin detail for the cash management document given.
CurrencyDetail	CashManagementServiceImpl.generateMasterCurrencyDetail(CashManagementDocument cmDoc) This method generates a master currency detail for the cash management document given.
List<CashieringItemInProcess>	CashManagementServiceImpl.getOpenItemsInProcess(CashManagementDocument cmDoc) This method retrieves a collection of open CashieringItemInProcess objects from the cash management document given and returns that collection.
List<CashieringItemInProcess>	CashManagementServiceImpl.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>	CashManagementServiceImpl.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	CashManagementServiceImpl.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.
protected void	CashManagementServiceImpl.saveChecks(CashManagementDocument cmDoc) This method retrieves all the checks for the given document and persists them.
protected void	CashManagementServiceImpl.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	CashManagementServiceImpl.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	CashManagementServiceImpl.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	CashManagementServiceImpl.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.
protected void	CashManagementServiceImpl.transferChecksToCashManagementDocument(CashManagementDocument cmDoc, CashieringTransaction trans) This method retrieves the checks from the transaction and adds them to the cash management document.
protected void	CashManagementServiceImpl.validateDepositParams(CashManagementDocument cashManagementDoc, Bank bank, List<CashReceiptDocument> selectedCashReceipts) Validates the given Deposit parameters, throwing various (runtime) exceptions if errors exist.
boolean	CashManagementServiceImpl.verifyCashReceiptIsDeposited(CashManagementDocument cmDoc, CashReceiptDocument crDoc) Verifies if a given cash receipt is deposited as part of the given cash management document.

Uses of CashManagementDocument in org.kuali.kfs.fp.document.validation.impl

Methods in org.kuali.kfs.fp.document.validation.impl with parameters of type CashManagementDocument

protected boolean	CashManagementDocumentPreRules.checkBankCodeActive(CashManagementDocument cmDocument) If bank specification is enabled, prompts user to use the continuation bank code when the given bank code is inactive
protected boolean	CashManagementDocumentRule.validateDeposits(CashManagementDocument cmd) Validates all Deposits associated with the given CashManagementDocument
protected boolean	CashManagementDocumentRule.verifyAllVerifiedCashReceiptsDeposited(CashManagementDocument cmDoc) Verifies that all verified cash receipts have been deposited
protected void	CashManagementDocumentRule.verifyCashDrawerForVerificationUnitIsOpenForPostInitiationSaves(CashManagementDocument cmd) This method checks to make sure that the cash drawer is closed for the associated verification unit, for post initiation saves for CashManagementDocuments which don't have Final
protected void	CashManagementDocumentRule.verifyUserIsDocumentInitiator(CashManagementDocument cmd) This method checks to make sure that the current system user is the person that initiated this document in the first place.

Uses of CashManagementDocument in org.kuali.kfs.fp.document.web.struts

Methods in org.kuali.kfs.fp.document.web.struts that return CashManagementDocument

CashManagementDocument

CashManagementForm.getCashManagementDocument()

Methods in org.kuali.kfs.fp.document.web.struts with parameters of type CashManagementDocument

protected String	CashManagementAction.buildCashDrawerCorrectionUrl(CashManagementDocument cmDoc)
protected String	CashManagementAction.buildDepositWizardUrl(CashManagementDocument cmDoc, String depositTypeCode)
protected org.kuali.rice.kns.util.KualiDecimal	CashManagementForm.CashDrawerSummary.calculateDepositedCashieringChecksTotal(CashManagementDocument cmDoc)
protected Map<String,org.kuali.rice.kns.util.KualiDecimal>	CashManagementForm.CashDrawerSummary.calculateDepositedCashieringChecksTotalByDepositType(CashManagementDocument cmDoc)
protected org.kuali.rice.kns.util.KualiDecimal	CashManagementForm.CashDrawerSummary.calculateOpenItemsTotal(CashManagementDocument cmDoc)
protected org.kuali.rice.kns.util.KualiDecimal	CashManagementForm.CashDrawerSummary.calculateUndepositedCashieringChecksTotal(CashManagementDocument cmDoc)
protected void	CashManagementAction.checkDepositAuthorization(CashManagementForm cmForm, CashManagementDocument cmDoc) Throws a DocumentAuthorizationException if the current user is not authorized to add a deposit of the given type to the given document.
void	CashManagementForm.CashDrawerSummary.resummarize(CashManagementDocument cmDoc)

Constructors in org.kuali.kfs.fp.document.web.struts with parameters of type CashManagementDocument

CashManagementForm.CashDrawerSummary(CashManagementDocument cmDoc)