org.kuali.ole.fp.document.web.struts

Class DepositWizardForm

java.lang.Object

org.apache.struts.action.ActionForm

org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.ole.fp.document.web.struts.DepositWizardForm

All Implemented Interfaces:

Serializable, org.kuali.rice.kns.web.struts.form.pojo.PojoForm

public class DepositWizardForm
extends org.kuali.rice.kns.web.struts.form.KualiForm

This class is the action form for the deposit document wizard.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.rice.kns.web.struts.form.KualiForm.TabState

Field Summary

Fields

Modifier and Type	Field and Description
protected Map	documentActions
protected Map	editingMode
protected String	noVerifiedCashErrorMessage

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

extraButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

requiredNonEditableProperties

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor and Description
DepositWizardForm() Constructs a DepositWizardForm class instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCashieringTransactionToTargetTotal(org.kuali.rice.core.api.util.type.KualiDecimal undepositedCheckAmount) Adds total undeposited cashiering transaction amount to the target total
void	addCashReceiptToChecks(CashReceiptDocument crDoc) Adds the check total for a cash receipt to checks
void	addCashReceiptToTargetTotal(CashReceiptDocument crDoc) Adds a cash receipt to the target total amount for the given deposit (if the deposit was final) The amount to add is: confirmed check amount + confirmed currency amount + confirmed coin amount - change request currency amount - change request coin amount
Bank	getBank()
String	getBankCode()
String	getCashDrawerCampusCode()
String	getCashManagementDocId()
CashReceiptDocument	getCheckFreeCashReceipt(int index) Retreive a single check free cash receipt
List<CashReceiptDocument>	getCheckFreeCashReceipts() Gets the checkFreeCashReceipts attribute.
CoinDetail	getCoinDetail() Gets the coinDetail attribute.
CurrencyDetail	getCurrencyDetail() Gets the currencyDetail attribute.
String	getCurrencyFormattedSumTotalAmount() Retrieves the summed total amount in a currency format with commas.
org.kuali.rice.core.api.util.type.KualiDecimal	getCurrentCheckTotal()
Check	getDepositableCashieringCheck(int index) Return the deposit cashiering check at the given index
List<Check>	getDepositableCashieringChecks() Gets the depositableCashieringChecks attribute.
CashReceiptDocument	getDepositableCashReceipt(int i)
List<CashReceiptDocument>	getDepositableCashReceipts()
String	getDepositTicketNumber()
String	getDepositTypeCode()
String	getDepositTypeString() Hack to make the translated depositTypeCode more readily available to the JSP
DepositWizardCashieringCheckHelper	getDepositWizardCashieringCheckHelper(int index)
List<DepositWizardCashieringCheckHelper>	getDepositWizardCashieringCheckHelpers() Gets the depositWizardCashieringCheckHelpers attribute.
DepositWizardHelper	getDepositWizardHelper(int index) This method retrieves whether the cash receipt ID at the specified index will be selected or not.
List	getDepositWizardHelpers()
Map	getDocumentActions() Gets the documentActions attribute.
Map	getEditingMode() Gets the editingMode attribute.
String	getNoVerifiedCashErrorMessage()
org.kuali.rice.core.api.util.type.KualiDecimal	getTargetDepositAmount()
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalCashAmount() Gets the totalCashAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalCoinAmount() Gets the totalCoinAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmount() This method returns the overall total of the document - coin plus check plus cash.
boolean	isDepositFinal() Explains if this deposit form is for creating a final deposit or not
void	setBank(Bank bank) Sets the bank attribute value.
void	setBankCode(String bankCode) Sets the bankCode attribute value.
void	setCashDrawerCampusCode(String cashDrawerVerificationUnit) Sets the cashDrawerCampusCode attribute value.
void	setCashManagementDocId(String cashManagementDocId) Sets the cashManagementDocId attribute value.
void	setCheckFreeCashReceipts(List<CashReceiptDocument> checkFreeCashReceipts) Sets the checkFreeCashReceipts attribute value.
void	setCoinDetail(CoinDetail coinDetail) Sets the coinDetail attribute value.
void	setCurrencyDetail(CurrencyDetail currencyDetail) Sets the currencyDetail attribute value.
void	setDefaultBankCode() Sets the bank code for a new deposit to the setup default for the Cash Management document.
void	setDepositableCashieringChecks(List<Check> depositableCashieringChecks) Sets the depositableCashieringChecks attribute value.
void	setDepositableCashReceipts(List cashReceiptsReadyForDeposit)
void	setDepositTicketNumber(String depositTicketNumber) Sets the depositTicketNumber attribute value.
void	setDepositTypeCode(String depositTypeCode)
void	setDepositWizardCashieringCheckHelpers(List<DepositWizardCashieringCheckHelper> depositWizardCashieringCheckHelpers) Sets the depositWizardCashieringCheckHelpers attribute value.
void	setDepositWizardHelpers(List depositWizardHelpers)
void	setDocumentActions(Map documentActions) Sets the documentActions attribute value.
void	setEditingMode(Map editingMode) Sets the editingMode attribute value.
void	setNoVerifiedCashErrorMessage(String noVerifiedCashErrorMessage)

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

addRequiredNonEditableProperties, clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getExtraButtons, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getMethodToCall, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populate, populateBackLocation, populateFieldLevelHelpEnabled, reset, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDerivedValuesOnForm, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setMethodToCall, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates, shouldMethodToCallParameterBeUsed, shouldPropertyBePopulatedInForm

Methods inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, customInitMaxUploadSizes, formatterClassForKeypath, formatValue, getActionEditablePropertiesGuid, getEditableProperties, getFormatter, getFormatterTypes, getIsNewForm, getMaxUploadSizes, getMethodToCallsToBypassSessionRetrievalForGETRequests, getParameter, getParameterValues, getPopulateEditableProperties, getPopulateEditablePropertiesGuid, getPropertyType, getRequiredNonEditableProperties, getStrutsActionMappingScope, getUnconvertedValues, getUnknownKeys, initMaxUploadSizes, isPropertyEditable, isPropertyNonEditableButRequired, populateForProperty, postprocessRequestParameters, processValidationFail, registerEditableProperty, registerIsNewForm, registerRequiredNonEditableProperty, registerStrutsActionMappingScope, setActionEditablePropertiesGuid, setFormatterType, setFormatterTypes, setPopulateEditablePropertiesGuid, setUnconvertedValues

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate, validate

Methods inherited from class java.lang.Object

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

Field Detail

editingMode

protected Map editingMode

documentActions

protected Map documentActions

noVerifiedCashErrorMessage

protected String noVerifiedCashErrorMessage

Constructor Detail

DepositWizardForm

public DepositWizardForm()

Constructs a DepositWizardForm class instance.

Method Detail

setDefaultBankCode

public void setDefaultBankCode()

Sets the bank code for a new deposit to the setup default for the Cash Management document.

getCashManagementDocId

public String getCashManagementDocId()

Returns:

current value of cashManagementDocId.

setCashManagementDocId

public void setCashManagementDocId(String cashManagementDocId)

Sets the cashManagementDocId attribute value.

Parameters:

cashManagementDocId - The cashManagementDocId to set.

setDepositTypeCode

public void setDepositTypeCode(String depositTypeCode)

Parameters:

depositTypeCode -

getDepositTypeCode

public String getDepositTypeCode()

Returns:

depositTypeCode

getDepositTypeString

public String getDepositTypeString()

Hack to make the translated depositTypeCode more readily available to the JSP

Returns:

translated depositTypeCode

getDepositableCashReceipts

public List<CashReceiptDocument> getDepositableCashReceipts()

Returns:

List

setDepositableCashReceipts

public void setDepositableCashReceipts(List cashReceiptsReadyForDeposit)

Parameters:

cashReceiptsReadyForDeposit -

getDepositableCashReceipt

public CashReceiptDocument getDepositableCashReceipt(int i)

getDepositWizardHelpers

public List getDepositWizardHelpers()

Returns:

ArrayList

setDepositWizardHelpers

public void setDepositWizardHelpers(List depositWizardHelpers)

Parameters:

depositWizardHelpers -

getDepositWizardHelper

public DepositWizardHelper getDepositWizardHelper(int index)

This method retrieves whether the cash receipt ID at the specified index will be selected or not.

Parameters:

index -

Returns:

DepositWizarHelper

getCashDrawerCampusCode

public String getCashDrawerCampusCode()

Returns:

current value of cashDrawerCampusCode.

setCashDrawerCampusCode

public void setCashDrawerCampusCode(String cashDrawerVerificationUnit)

Sets the cashDrawerCampusCode attribute value.

Parameters:

cashDrawerCampusCode - The cashDrawerCampusCode to set.

getBankCode

public String getBankCode()

Returns:

current value of bankCode.

setBankCode

public void setBankCode(String bankCode)

Sets the bankCode attribute value.

Parameters:

bankCode - The bankCode to set.

getDepositTicketNumber

public String getDepositTicketNumber()

Returns:

current value of depositTicketNumber.

setDepositTicketNumber

public void setDepositTicketNumber(String depositTicketNumber)

Sets the depositTicketNumber attribute value.

Parameters:

depositTicketNumber - The depositTicketNumber to set.

getBank

public Bank getBank()

Returns:

current value of bank.

setBank

public void setBank(Bank bank)

Sets the bank attribute value.

Parameters:

bank - The bank to set.

getCoinDetail

public CoinDetail getCoinDetail()

Gets the coinDetail attribute.

Returns:

Returns the coinDetail.

setCoinDetail

public void setCoinDetail(CoinDetail coinDetail)

Sets the coinDetail attribute value.

Parameters:

coinDetail - The coinDetail to set.

getCurrencyDetail

public CurrencyDetail getCurrencyDetail()

Gets the currencyDetail attribute.

Returns:

Returns the currencyDetail.

setCurrencyDetail

public void setCurrencyDetail(CurrencyDetail currencyDetail)

Sets the currencyDetail attribute value.

Parameters:

currencyDetail - The currencyDetail to set.

getCurrencyFormattedSumTotalAmount

public String getCurrencyFormattedSumTotalAmount()

Retrieves the summed total amount in a currency format with commas.

Returns:

String

getTotalDollarAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalDollarAmount()

This method returns the overall total of the document - coin plus check plus cash.

Returns:

KualiDecimal

getTotalCoinAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalCoinAmount()

Gets the totalCoinAmount attribute.

Returns:

Returns the totalCoinAmount.

getTotalCashAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalCashAmount()

Gets the totalCashAmount attribute.

Returns:

Returns the totalCashAmount.

isDepositFinal

public boolean isDepositFinal()

Explains if this deposit form is for creating a final deposit or not

Returns:

true if this deposit form will create a final deposit, false if it will create an interim

getDepositableCashieringChecks

public List<Check> getDepositableCashieringChecks()

Gets the depositableCashieringChecks attribute.

Returns:

Returns the depositableCashieringChecks.

setDepositableCashieringChecks

public void setDepositableCashieringChecks(List<Check> depositableCashieringChecks)

Sets the depositableCashieringChecks attribute value.

Parameters:

depositableCashieringChecks - The depositableCashieringChecks to set.

getDepositableCashieringCheck

public Check getDepositableCashieringCheck(int index)

Return the deposit cashiering check at the given index

Parameters:

index - index of check to retrieve

Returns:

a check

getDepositWizardCashieringCheckHelpers

public List<DepositWizardCashieringCheckHelper> getDepositWizardCashieringCheckHelpers()

Gets the depositWizardCashieringCheckHelpers attribute.

Returns:

Returns the depositWizardCashieringCheckHelpers.

getCheckFreeCashReceipts

public List<CashReceiptDocument> getCheckFreeCashReceipts()

Gets the checkFreeCashReceipts attribute.

Returns:

Returns the checkFreeCashReceipts.

setCheckFreeCashReceipts

public void setCheckFreeCashReceipts(List<CashReceiptDocument> checkFreeCashReceipts)

Sets the checkFreeCashReceipts attribute value.

Parameters:

checkFreeCashReceipts - The checkFreeCashReceipts to set.

getCheckFreeCashReceipt

public CashReceiptDocument getCheckFreeCashReceipt(int index)

Retreive a single check free cash receipt

Parameters:

index - the index of the cash receipt

Returns:

a cash receipt document

setDepositWizardCashieringCheckHelpers

public void setDepositWizardCashieringCheckHelpers(List<DepositWizardCashieringCheckHelper> depositWizardCashieringCheckHelpers)

Sets the depositWizardCashieringCheckHelpers attribute value.

Parameters:

depositWizardCashieringCheckHelpers - The depositWizardCashieringCheckHelpers to set.

getDepositWizardCashieringCheckHelper

public DepositWizardCashieringCheckHelper getDepositWizardCashieringCheckHelper(int index)

getDocumentActions

public Map getDocumentActions()

Gets the documentActions attribute.

Returns:

Returns the documentActions.

setDocumentActions

public void setDocumentActions(Map documentActions)

Sets the documentActions attribute value.

Parameters:

documentActions - The documentActions to set.

getEditingMode

public Map getEditingMode()

Gets the editingMode attribute.

Returns:

Returns the editingMode.

setEditingMode

public void setEditingMode(Map editingMode)

Sets the editingMode attribute value.

Parameters:

editingMode - The editingMode to set.

getTargetDepositAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTargetDepositAmount()

Returns:

the total target amount which needs deposited

addCashReceiptToTargetTotal

public void addCashReceiptToTargetTotal(CashReceiptDocument crDoc)

Adds a cash receipt to the target total amount for the given deposit (if the deposit was final) The amount to add is: confirmed check amount + confirmed currency amount + confirmed coin amount - change request currency amount - change request coin amount

Parameters:

crDoc -

addCashieringTransactionToTargetTotal

public void addCashieringTransactionToTargetTotal(org.kuali.rice.core.api.util.type.KualiDecimal undepositedCheckAmount)

Adds total undeposited cashiering transaction amount to the target total

Parameters:

transaction -

getCurrentCheckTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getCurrentCheckTotal()

Returns:

the current amount for checks needing depositing

addCashReceiptToChecks

public void addCashReceiptToChecks(CashReceiptDocument crDoc)

Adds the check total for a cash receipt to checks

Parameters:

crDoc -

getNoVerifiedCashErrorMessage

public String getNoVerifiedCashErrorMessage()

Returns:

the no verified cash error message

setNoVerifiedCashErrorMessage

public void setNoVerifiedCashErrorMessage(String noVerifiedCashErrorMessage)

Parameters:

noVerifiedCashErrorMessage - the noVerifiedCashErrorMessage to set