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

Class CashReceiptForm

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.rice.kns.web.struts.form.KualiDocumentFormBase

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

org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase

org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

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

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

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

All Implemented Interfaces:

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

public class CashReceiptForm
extends CapitalAccountingLinesFormBase
implements CapitalAssetEditable

This class is the action form for Cash Receipts.

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 List	baselineChecks
protected static String	CAN_PRINT_COVERSHEET_SIG_STR
protected List<CapitalAssetInformation>	capitalAssetInformation
protected String	checkEntryMode
protected List	checkEntryModes
protected org.kuali.rice.core.api.util.type.KualiDecimal	checkTotal
protected Check	newCheck
protected Check	newConfirmedCheck
protected static long	serialVersionUID

Fields inherited from class org.kuali.ole.fp.document.web.struts.CapitalAccountingLinesFormBase

capitalAccountingLine, createdAssetsControlAmount, distributeEqualAmount, editCreateOrModify, systemControlAmount

Fields inherited from class org.kuali.ole.fp.document.web.struts.CapitalAssetInformationFormBase

LOG, lookedUpCollectionName, lookupResultsBOClassName, lookupResultsSequenceNumber

Fields inherited from class org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

editableAccounts, forcedLookupOptionalFields, hideDetails, newSourceLine, newTargetLine, sourceFile, targetFile

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

forcedReadOnlyFields

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

adHocActionRequestCodes, attachmentFile, documentActions, editingMode, suppressAllButtons

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
CashReceiptForm() Constructs a CashReceiptForm.java.

Method Summary

Methods

Modifier and Type	Method and Description
Check	getBaselineCheck(int index) Implementation creates empty Checks as a side-effect, so that Struts' efforts to set fields of lines which haven't been created will succeed rather than causing a NullPointerException.
List	getBaselineChecks()
List<CapitalAssetInformation>	getCapitalAssetInformation() Gets the capitalAssetInformation attribute.
String	getCashDrawerStatusMessage() This method will build out a message in the case the document is ENROUTE and the cash drawer is closed.
CashReceiptDocument	getCashReceiptDocument()
String	getCheckEntryMode()
List	getCheckEntryModes()
org.kuali.rice.core.api.util.type.KualiDecimal	getCheckTotal()
protected String	getDefaultDocumentTypeName()
protected List<String>	getExcludedmethodToCall() get the names of the methods to call that can be excluded from the "be used" check.
String	getFinancialDocumentStatusMessage() Gets the financialDocumentStatusMessage which is dependent upon document state.
Check	getNewCheck()
Check	getNewConfirmedCheck()
boolean	hasBaselineCheck(int index)
boolean	isCheckEntryDetailMode()
boolean	isCoverSheetPrintingAllowed() determines if the CashReceiptDocument is in a state that allows printing of the cover sheet.
void	populate(javax.servlet.http.HttpServletRequest request) Overrides the parent to call super.populate and then to call the accounting lines populate method that is specific to loading the two select lists on the page.
void	setBaselineChecks(List baselineChecks) Sets the current List of baseline checks to the given List
void	setCapitalAssetInformation(List<CapitalAssetInformation> capitalAssetInformation) Sets the capitalAssetInformation attribute.
void	setCheckEntryMode(String checkEntryMode)
void	setCheckTotal(org.kuali.rice.core.api.util.type.KualiDecimal checkTotal)
void	setNewCheck(Check newCheck)
void	setNewConfirmedCheck(Check newConfirmedCheck)

Methods inherited from class org.kuali.ole.fp.document.web.struts.CapitalAccountingLinesFormBase

getCapitalAccountingLine, getCreatedAssetsControlAmount, getSystemControlAmount, isDistributeEqualAmount, isEditCreateOrModify, setCapitalAccountingLine, setCreatedAssetsControlAmount, setDistributeEqualAmount, setEditCreateOrModify, setSystemControlAmount

Methods inherited from class org.kuali.ole.fp.document.web.struts.CapitalAssetInformationFormBase

addRequiredNonEditableProperties, getLookedUpCollectionName, getLookupResultsBOClassName, getLookupResultsSequenceNumber, getRefreshCaller, setLookedUpCollectionName, setLookupResultsBOClassName, setLookupResultsSequenceNumber

Methods inherited from class org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

createNewSourceAccountingLine, createNewTargetAccountingLine, customInitMaxUploadSizes, getAccountingLineImportInstructionsUrl, getCurrencyFormattedSourceTotal, getCurrencyFormattedTargetTotal, getEditableAccounts, getFinancialDocument, getForcedLookupOptionalFields, getHideDetails, getNewSourceLine, getNewTargetLine, getSourceFile, getTargetFile, harvestAccountingLines, isHideDetails, populateAccountingLine, populateAccountingLines, populateAccountingLinesForResponse, populateSourceAccountingLine, populateTargetAccountingLine, repopulateOverrides, setEditableAccounts, setForcedLookupOptionalFields, setHideDetails, setNewSourceLine, setNewTargetLine, setSourceFile, setTargetFile, shouldMethodToCallParameterBeUsed

Methods inherited from class org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase

extendDocInfoToThreeColumns, generateErrorCorrectionButton, getExtraButtons, populateHeaderFields

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

discoverDocumentTypeName, formatReversalDate, getForcedReadOnlyFields, getTransactionalDocument, instantiateTransactionalDocumentByDocumentTypeName, populateEmptyMultiSelect, populateFalseCheckboxes, populationSpecialEmptyFields, setForcedReadOnlyFields

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

buildHtmlLink, getActionRequests, getActionRequestsRequiringApproval, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDocId, getDocNum, getDocTypeName, getDocument, getDocumentActions, getDocumentHandlerUrl, getEditingMode, getFormKey, getInitiator, getInitiatorNetworkId, getMessageMapFromPreviousRequest, getNewAdHocRoutePerson, getNewAdHocRouteWorkgroup, getNewNote, getPersonInquiryUrlLink, getSelectedActionRequests, getStandardHeaderFields, getSuperUserAnnotation, getWorkflowDocument, hasDocumentId, initializeHeaderNavigationTabs, instantiateDocument, isDocumentEnRoute, isFormDocumentInitialized, isHasWorkflowDocument, isReturnToActionList, isStateAllowsApproveOrDisapprove, isStateAllowsApproveSingleActionRequest, isStateInitiatedFinalCancelled, isStateProcessedOrDisapproved, isSuperUserActionAvaliable, isSuperUserApproveDocumentAuthorized, isSuperUserApproveSingleActionRequestAuthorized, isSuperUserAuthorized, isSuperUserDisapproveDocumentAuthorized, isSuppressAllButtons, isUserDocumentInitiator, reset, setActionRequests, setAdditionalScriptFile, setAdditionalScriptFiles, setAdHocActionRequestCodes, setAdHocRoutePersons, setAdHocRouteWorkgroups, setAnnotation, setAttachmentFile, setBoNotes, setCommand, setDerivedValuesOnForm, setDocId, setDocNum, setDocTypeName, setDocument, setDocumentActions, setEditingMode, setFormKey, setMessageMapFromPreviousRequest, setNewAdHocRoutePerson, setNewAdHocRouteWorkgroup, setNewNote, setReturnToActionList, setSelectedActionRequests, setSuperUserAnnotation, setSuppressAllButtons, shouldPropertyBePopulatedInForm, validate

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

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

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

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, 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

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

CAN_PRINT_COVERSHEET_SIG_STR

protected static final String CAN_PRINT_COVERSHEET_SIG_STR

See Also:

Constant Field Values

newCheck

protected Check newCheck

newConfirmedCheck

protected Check newConfirmedCheck

checkTotal

protected org.kuali.rice.core.api.util.type.KualiDecimal checkTotal

checkEntryMode

protected String checkEntryMode

checkEntryModes

protected List checkEntryModes

baselineChecks

protected List baselineChecks

capitalAssetInformation

protected List<CapitalAssetInformation> capitalAssetInformation

Constructor Detail

CashReceiptForm

public CashReceiptForm()

Constructs a CashReceiptForm.java.

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

getDefaultDocumentTypeName in class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

populate

public void populate(javax.servlet.http.HttpServletRequest request)

Description copied from class: KualiAccountingDocumentFormBase

Overrides the parent to call super.populate and then to call the accounting lines populate method that is specific to loading the two select lists on the page.

Specified by:

populate in interface org.kuali.rice.kns.web.struts.form.pojo.PojoForm

Overrides:

populate in class KualiAccountingDocumentFormBase

See Also:

org.kuali.rice.kns.web.struts.pojo.PojoForm#populate(javax.servlet.http.HttpServletRequest)

getCashReceiptDocument

public CashReceiptDocument getCashReceiptDocument()

Returns:

CashReceiptDocument

getNewCheck

public Check getNewCheck()

Returns:

Check

setNewCheck

public void setNewCheck(Check newCheck)

Parameters:

newCheck -

getNewConfirmedCheck

public Check getNewConfirmedCheck()

Returns:

Confirmed Check

setNewConfirmedCheck

public void setNewConfirmedCheck(Check newConfirmedCheck)

Parameters:

newConfirmedCheck -

setCheckTotal

public void setCheckTotal(org.kuali.rice.core.api.util.type.KualiDecimal checkTotal)

Parameters:

checkTotal -

getCheckTotal

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

Returns:

KualiDecimal

getCheckEntryModes

public List getCheckEntryModes()

Returns:

List of LabelValueBeans representing all available check entry modes

getCheckEntryMode

public String getCheckEntryMode()

Returns:

String

setCheckEntryMode

public void setCheckEntryMode(String checkEntryMode)

Parameters:

checkEntryMode -

isCheckEntryDetailMode

public boolean isCheckEntryDetailMode()

Returns:

boolean

getBaselineChecks

public List getBaselineChecks()

Returns:

current List of baseline checks for use in update detection

setBaselineChecks

public void setBaselineChecks(List baselineChecks)

Sets the current List of baseline checks to the given List

Parameters:

baselineChecks -

hasBaselineCheck

public boolean hasBaselineCheck(int index)

Parameters:

index -

Returns:

true if a baselineCheck with the given index exists

getBaselineCheck

public Check getBaselineCheck(int index)

Implementation creates empty Checks as a side-effect, so that Struts' efforts to set fields of lines which haven't been created will succeed rather than causing a NullPointerException.

Parameters:

index -

Returns:

baseline Check at the given index

getFinancialDocumentStatusMessage

public String getFinancialDocumentStatusMessage()

Gets the financialDocumentStatusMessage which is dependent upon document state.

Returns:

Returns the financialDocumentStatusMessage.

getCashDrawerStatusMessage

public String getCashDrawerStatusMessage()

This method will build out a message in the case the document is ENROUTE and the cash drawer is closed.

Returns:

String

isCoverSheetPrintingAllowed

public boolean isCoverSheetPrintingAllowed()

determines if the CashReceiptDocument is in a state that allows printing of the cover sheet.

Returns:

boolean

getCapitalAssetInformation

public List<CapitalAssetInformation> getCapitalAssetInformation()

Description copied from interface: CapitalAssetEditable

Gets the capitalAssetInformation attribute.

Specified by:

getCapitalAssetInformation in interface CapitalAssetEditable

Returns:

Returns the capitalAssetInformation.

See Also:

CapitalAssetEditable.getCapitalAssetInformation()

setCapitalAssetInformation

public void setCapitalAssetInformation(List<CapitalAssetInformation> capitalAssetInformation)

Description copied from interface: CapitalAssetEditable

Sets the capitalAssetInformation attribute.

Specified by:

setCapitalAssetInformation in interface CapitalAssetEditable

See Also:

org.kuali.ole.fp.document.CapitalAssetEditable#setCapitalAssetInformation(org.kuali.ole.fp.businessobject.CapitalAssetInformation)

getExcludedmethodToCall

protected List<String> getExcludedmethodToCall()

Description copied from class: KualiAccountingDocumentFormBase

get the names of the methods to call that can be excluded from the "be used" check.

Overrides:

getExcludedmethodToCall in class KualiAccountingDocumentFormBase

Returns:

the names of the methods to call that can be excluded from the "be used" check

See Also:

KualiAccountingDocumentFormBase.getExcludedmethodToCall()