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

java.lang.Object
  org.apache.struts.action.Action
      org.apache.struts.actions.DispatchAction
          org.kuali.rice.kns.web.struts.action.KualiAction
              org.kuali.kfs.fp.document.web.struts.DepositWizardAction

public class DepositWizardAction
extends org.kuali.rice.kns.web.struts.action.KualiAction

This class handles actions for the deposit wizard, which is used to create deposits that bundle groupings of Cash Receipt documents.

Field Summary

Fields inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

FORM_ACTION, FORWARD_NEXT, FORWARD_TEXT_AREA_UPDATE, METHOD_TO_CALL, POST_TEXT_AREA_TO_PARENT, TEXT_AREA_FIELD_ANCHOR, TEXT_AREA_FIELD_LABEL, TEXT_AREA_FIELD_NAME, TEXT_AREA_MAX_LENGTH, TEXT_AREA_READ_ONLY

Fields inherited from class org.apache.struts.actions.DispatchAction

clazz, log, messages, methods, types

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

defaultLocale, servlet

Constructor Summary

DepositWizardAction()

Method Summary

org.apache.struts.action.ActionForward	cancel(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method handles canceling (closing) the deposit wizard.
boolean	checkEnoughCoinForDeposit(DepositWizardForm depositForm) Checks that the coin amount requested by the deposit does not exceed the amount actually in the drawer
protected Map	convertSetToMap(Set s) Converts a set into a map, where each value in the set becomes a key and each value becomes KNSConstants.KUALI_DEFAULT_TRUE_VALUE
org.apache.struts.action.ActionForward	createDeposit(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is the action method for creating the new deposit document from the information chosen by the user in the UI.
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Overrides the parent to validate the document state of the cashManagementDocument which will be updated and redisplayed after the DepositWizard builds and attaches the new Deposit.
protected String	getCashManagementDocumentTypeName()
org.apache.struts.action.ActionForward	refresh(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Reloads the CashReceipts, leaving everything else unchanged
org.apache.struts.action.ActionForward	startWizard(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is the starting point for the deposit document wizard.

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

addMethodToCallToUncheckedList, checkAuthorization, defaultDispatch, dispatchMethod, doProcessingAfterPost, findMethodToCall, getApplicationBaseUrl, getBasePath, getBusinessObjectAuthorizationService, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, hideAllTabs, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, showAllTabs, toggleTab, updateTextArea, validateLookupInquiryFullParameter

Methods inherited from class org.apache.struts.actions.DispatchAction

cancelled, getMethod, getMethodName, getParameter, unspecified

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

addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Constructor Detail

DepositWizardAction

public DepositWizardAction()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws Exception

Overrides the parent to validate the document state of the cashManagementDocument which will be updated and redisplayed after the DepositWizard builds and attaches the new Deposit.

Overrides:

execute in class org.kuali.rice.kns.web.struts.action.KualiAction

Throws:

Exception

See Also:

Action.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getCashManagementDocumentTypeName

protected String getCashManagementDocumentTypeName()

Returns:

the class of the cash management document

convertSetToMap

protected Map convertSetToMap(Set s)

Converts a set into a map, where each value in the set becomes a key and each value becomes KNSConstants.KUALI_DEFAULT_TRUE_VALUE

Parameters:

s - a set

Returns:

a map

refresh

public org.apache.struts.action.ActionForward refresh(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws Exception

Reloads the CashReceipts, leaving everything else unchanged

Overrides:

refresh in class org.kuali.rice.kns.web.struts.action.KualiAction

Throws:

Exception

See Also:

KualiAction.refresh(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

startWizard

public org.apache.struts.action.ActionForward startWizard(org.apache.struts.action.ActionMapping mapping,
                                                          org.apache.struts.action.ActionForm form,
                                                          javax.servlet.http.HttpServletRequest request,
                                                          javax.servlet.http.HttpServletResponse response)
                                                   throws Exception

This method is the starting point for the deposit document wizard.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

createDeposit

public org.apache.struts.action.ActionForward createDeposit(org.apache.struts.action.ActionMapping mapping,
                                                            org.apache.struts.action.ActionForm form,
                                                            javax.servlet.http.HttpServletRequest request,
                                                            javax.servlet.http.HttpServletResponse response)

This method is the action method for creating the new deposit document from the information chosen by the user in the UI.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

checkEnoughCoinForDeposit

public boolean checkEnoughCoinForDeposit(DepositWizardForm depositForm)

Checks that the coin amount requested by the deposit does not exceed the amount actually in the drawer

Parameters:

depositForm - the deposit form we are checking against

detail - the coin detail to check against the drawer

Returns:

true if there is enough coin, false if otherwise

cancel

public org.apache.struts.action.ActionForward cancel(org.apache.struts.action.ActionMapping mapping,
                                                     org.apache.struts.action.ActionForm form,
                                                     javax.servlet.http.HttpServletRequest request,
                                                     javax.servlet.http.HttpServletResponse response)
                                              throws Exception

This method handles canceling (closing) the deposit wizard.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception