org.kuali.kfs.fp.document.web.struts
Class CashManagementForm

java.lang.Object
  org.apache.struts.action.ActionForm
      org.kuali.rice.kns.web.struts.pojo.PojoFormBase
          org.kuali.rice.kns.web.struts.form.KualiForm
              org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase
                  org.kuali.kfs.fp.document.web.struts.CashManagementForm

All Implemented Interfaces:

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

public class CashManagementForm
extends org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

This class is the action form for CashManagement

See Also:

Serialized Form

Nested Class Summary

static class	CashManagementForm.CashDrawerSummary
static class	CashManagementForm.CashReceiptSummary
static class	CashManagementForm.DepositHelper Inner helper class.

Field Summary

protected static String	CAMPUS_CODE_PROPERTY
protected CashManagementForm.CashDrawerSummary	cashDrawerSummary
protected CashManagementDocumentPresentationController	cmDocPrezController
protected List	depositHelpers
protected static org.apache.log4j.Logger	LOG
protected List<CashieringItemInProcess>	recentlyClosedItemsInProcess
protected static long	serialVersionUID

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.pojo.PojoFormBase

requiredNonEditableProperties

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

multipartRequestHandler, servlet

Constructor Summary

CashManagementForm()
Constructs a CashManagementForm.

Method Summary

protected CashManagementDocumentPresentationController	createCashManagementDocumentPresentationController() Creates an instance of the appropriate implementation of CashManagementDocumentPresentationController to check the cash drawer opening logic
boolean	getAllowOpenCashDrawer()
CashManagementForm.CashDrawerSummary	getCashDrawerSummary()
CashManagementDocument	getCashManagementDocument()
protected String	getDefaultDocumentTypeName()
CashManagementForm.DepositHelper	getDepositHelper(int i)
List	getDepositHelpers()
List<CashieringItemInProcess>	getRecentlyClosedItemsInProcess() Gets the recentlyClosedItemsInProcess attribute.
boolean	isLastInterimDepositFinalizable() Tells any JSP page using this form whether an action can be taken to make the last interim deposit the final deposit
void	populateCashDrawerSummary() Creates and initializes a CashDrawerSummary for the related CashManagementDocument, if it is not currently closed
void	populateDepositHelpers() Creates a DepositHelper foreach Deposit associated with this form's document
void	postprocessRequestParameters(Map requestParameters)
CashManagementForm.DepositHelper	removeDepositHelper(int i) Removes and returns DepositHelper at the given index
void	setCashDrawerSummary(CashManagementForm.CashDrawerSummary cashDrawerSummary) Sets the CashDrawerSummary
void	setRecentlyClosedItemsInProcess(List<CashieringItemInProcess> recentlyClosedItemsInProcess) Sets the recentlyClosedItemsInProcess attribute value.

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

addRequiredNonEditableProperties, buildHtmlLink, customInitMaxUploadSizes, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDocId, getDocNum, getDocTypeName, getDocument, getDocumentActions, getDocumentHandlerUrl, getEditingMode, getErrorMapFromPreviousRequest, getFormKey, getInitiator, getInitiatorNetworkId, getMessageMapFromPreviousRequest, getNewAdHocRoutePerson, getNewAdHocRouteWorkgroup, getNewNote, getPersonInquiryUrlLink, getStandardHeaderFields, getWorkflowDocument, hasDocumentId, initializeHeaderNavigationTabs, instantiateDocument, isDocumentEnRoute, isFormDocumentInitialized, isHasWorkflowDocument, isReturnToActionList, isSuppressAllButtons, isUserDocumentInitiator, populate, populateHeaderFields, reset, setAdditionalScriptFile, setAdditionalScriptFiles, setAdHocActionRequestCodes, setAdHocRoutePersons, setAdHocRouteWorkgroups, setAnnotation, setAttachmentFile, setBoNotes, setCommand, setDerivedValuesOnForm, setDocId, setDocNum, setDocTypeName, setDocument, setDocumentActions, setEditingMode, setErrorMapFromPreviousRequest, setFormKey, setMessageMapFromPreviousRequest, setNewAdHocRoutePerson, setNewAdHocRouteWorkgroup, setNewNote, setReturnToActionList, setSuppressAllButtons, shouldMethodToCallParameterBeUsed, shouldPropertyBePopulatedInForm, validate

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

clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getExtraButtons, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getMethodToCall, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, 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.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, 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

LOG

protected static org.apache.log4j.Logger LOG

CAMPUS_CODE_PROPERTY

protected static final String CAMPUS_CODE_PROPERTY

See Also:

Constant Field Values

depositHelpers

protected transient List depositHelpers

cashDrawerSummary

protected CashManagementForm.CashDrawerSummary cashDrawerSummary

recentlyClosedItemsInProcess

protected List<CashieringItemInProcess> recentlyClosedItemsInProcess

cmDocPrezController

protected transient CashManagementDocumentPresentationController cmDocPrezController

Constructor Detail

CashManagementForm

public CashManagementForm()

Constructs a CashManagementForm.

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

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

getCashManagementDocument

public CashManagementDocument getCashManagementDocument()

Returns:

cashManagementDocument

populateDepositHelpers

public void populateDepositHelpers()

Creates a DepositHelper foreach Deposit associated with this form's document

populateCashDrawerSummary

public void populateCashDrawerSummary()

Creates and initializes a CashDrawerSummary for the related CashManagementDocument, if it is not currently closed

isLastInterimDepositFinalizable

public boolean isLastInterimDepositFinalizable()

Tells any JSP page using this form whether an action can be taken to make the last interim deposit the final deposit

Returns:

true if last interim deposit could be the final deposit, false if otherwise

getCashDrawerSummary

public CashManagementForm.CashDrawerSummary getCashDrawerSummary()

Returns:

CashDrawerSummary instance associated with this form, if any

setCashDrawerSummary

public void setCashDrawerSummary(CashManagementForm.CashDrawerSummary cashDrawerSummary)

Sets the CashDrawerSummary

getDepositHelpers

public List getDepositHelpers()

Returns:

List

getRecentlyClosedItemsInProcess

public List<CashieringItemInProcess> getRecentlyClosedItemsInProcess()

Gets the recentlyClosedItemsInProcess attribute.

Returns:

Returns the recentlyClosedItemsInProcess.

setRecentlyClosedItemsInProcess

public void setRecentlyClosedItemsInProcess(List<CashieringItemInProcess> recentlyClosedItemsInProcess)

Sets the recentlyClosedItemsInProcess attribute value.

Parameters:

recentlyClosedItemsInProcess - The recentlyClosedItemsInProcess to set.

getAllowOpenCashDrawer

public boolean getAllowOpenCashDrawer()

Returns:

true if the cash drawer can currently be opened, false otherwise

createCashManagementDocumentPresentationController

protected CashManagementDocumentPresentationController createCashManagementDocumentPresentationController()

Creates an instance of the appropriate implementation of CashManagementDocumentPresentationController to check the cash drawer opening logic

Returns:

an instance of the CashManagementDocumentPresentationController for the document

getDepositHelper

public CashManagementForm.DepositHelper getDepositHelper(int i)

Parameters:

i -

Returns:

DepositHelper

removeDepositHelper

public CashManagementForm.DepositHelper removeDepositHelper(int i)

Removes and returns DepositHelper at the given index

Parameters:

i -

Returns:

postprocessRequestParameters

public void postprocessRequestParameters(Map requestParameters)

Specified by:

postprocessRequestParameters in interface org.kuali.rice.kns.web.struts.pojo.PojoForm

Overrides:

postprocessRequestParameters in class org.kuali.rice.kns.web.struts.pojo.PojoFormBase

See Also:

PojoFormBase.postprocessRequestParameters(java.util.Map)