org.kuali.ole.fp.document.service

Interface CashReceiptService

All Known Implementing Classes:

CashReceiptServiceImpl

public interface CashReceiptService

This service interface defines the methods that a CashReceiptService implementation must provide.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCashDetailsToCashDrawer(CashReceiptDocument crDoc) This adds the currency and coin details associated with this Cash Receipt document to the proper cash drawer and to the cumulative Cash Receipt details for the document which opened the cash drawer.
boolean	areCashTotalsInvalid(CashReceiptDocument cashReceiptDocument) Checks whether the CashReceiptDocument's cash totals are invalid, generating global errors if so.
List	getCashReceipts(String verificationUnit, String statusCode) Returns a List of CashReceiptDocuments for the given verification unit whose status matches the given status code.
List	getCashReceipts(String verificationUnit, String[] statii) Returns a List of CashReceiptDocuments for the given verificationUnit whose status matches any of the status codes in the given String[].
String	getCashReceiptVerificationUnitForUser(org.kuali.rice.kim.api.identity.Person user) This method retrieves the cash receipt verification unit for the given user.

Method Detail

getCashReceiptVerificationUnitForUser

String getCashReceiptVerificationUnitForUser(org.kuali.rice.kim.api.identity.Person user)

This method retrieves the cash receipt verification unit for the given user. TODO: change this to do something other than return null (which will require updating CashReceiptDocumentAuthorizer, since that's the one place I'm sure that returning a null is interpreted to mean that a user is a member of no verificationUnit)

Parameters:

user - The user to retrieve the cash receipt verification unit for.

Returns:

Cash receipt verificationUnit campusCode associated with the given user; null if the user is not a member of any verification campus.

getCashReceipts

List getCashReceipts(String verificationUnit,
                   String statusCode)

Returns a List of CashReceiptDocuments for the given verification unit whose status matches the given status code.

Parameters:

verificationUnit - A verification unit for a cash receipt.

statusCode - A cash receipt status code.

Returns:

List of CashReceiptDocument instances.

Throws:

IllegalArgumentException - Thrown if verificationUnit is blank

IllegalArgumentException - Thrown if statusCode is blank

getCashReceipts

List getCashReceipts(String verificationUnit,
                   String[] statii)

Returns a List of CashReceiptDocuments for the given verificationUnit whose status matches any of the status codes in the given String[].

Parameters:

verificationUnit - A verification unit for a cash receipt.

statii - A collection of potential cash receipt document statuses.

Returns:

List of CashReceiptDocument instances.

Throws:

IllegalArgumentException - Thrown if verificationUnit is blank

IllegalArgumentException - Thrown if statii is null or empty or contains any blank statusCodes

addCashDetailsToCashDrawer

void addCashDetailsToCashDrawer(CashReceiptDocument crDoc)

This adds the currency and coin details associated with this Cash Receipt document to the proper cash drawer and to the cumulative Cash Receipt details for the document which opened the cash drawer.

Parameters:

crDoc - The cash receipt document with cash details to add to the cash drawer.

areCashTotalsInvalid

boolean areCashTotalsInvalid(CashReceiptDocument cashReceiptDocument)

Checks whether the CashReceiptDocument's cash totals are invalid, generating global errors if so.

Parameters:

cashReceiptDocument - submitted cash receipt document

Returns:

true if CashReceiptDocument's cash totals are valid