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

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

public class CashManagementAction
extends org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

Action class for CashManagementForm

Field Summary

protected static String	CASH_MANAGEMENT_STATUS_PAGE
protected static org.apache.log4j.Logger	LOG

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

DOCUMENT_LOAD_COMMANDS

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

CashManagementAction()
Default constructor

Method Summary

org.apache.struts.action.ActionForward	addCheck(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Adds Check instance created from the current "new check" line to the document
org.apache.struts.action.ActionForward	addFinalDeposit(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	addInterimDeposit(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	applyCashieringTransaction(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action applies the current cashiering transaction to the cash drawer
protected String	buildCashDrawerCorrectionUrl(CashManagementDocument cmDoc)
protected String	buildDepositWizardUrl(CashManagementDocument cmDoc, String depositTypeCode)
org.apache.struts.action.ActionForward	cancelDeposit(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	checkDepositAuthorization(CashManagementForm cmForm, CashManagementDocument cmDoc) Throws a DocumentAuthorizationException if the current user is not authorized to add a deposit of the given type to the given document.
org.apache.struts.action.ActionForward	correctCashDrawer(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action allows the user to go to the cash drawer correction screen
protected void	createDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase) Overrides the default document-creation code to auto-save new documents upon creation: since creating a CMDoc changes the CashDrawer's state as a side-effect, we need all CMDocs to be docsearchable so that someone can relocate and use or cancel whatever the current CMDoc is.
org.apache.struts.action.ActionForward	deleteCheck(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deletes the selected check (line) from the document
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 to call super, but also make sure the helpers are populated.
org.apache.struts.action.ActionForward	finalizeLastInterimDeposit(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action makes the last interim deposit a final deposit
org.apache.struts.action.ActionForward	openCashDrawer(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Saves the document, then opens the cash drawer
org.apache.struts.action.ActionForward	refreshSummary(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	reload(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	route(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Overridden to clear the CashDrawerSummary info

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

copy, populateAuthorizationFields

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

acknowledge, approve, attemptLockRelease, blanketApprove, buildAuthorizationException, cancel, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, close, combineAdHocRecipients, convertSetToMap, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, docHandler, doProcessingAfterPost, downloadBOAttachment, exitingDocument, fyi, generatePessimisticLockMessage, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getIdentityManagementService, getKualiConfigurationService, getKualiRuleService, getNoteService, getParameterService, getPessimisticLockService, getQuestion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, loadDocument, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, refresh, refreshAdHocRoutingWorkgroupLookups, releaseLocks, returnToSender, save, selectedAttachmentIndex, sendAdHocRequests, sendNoteWorkflowNotification, setupDocumentExit, setupPessimisticLockMessages, showAllTabs, streamToResponse, supervisorFunctions, toggleTab

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

addMethodToCallToUncheckedList, defaultDispatch, dispatchMethod, findMethodToCall, getApplicationBaseUrl, getBasePath, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, 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

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

CASH_MANAGEMENT_STATUS_PAGE

protected static final String CASH_MANAGEMENT_STATUS_PAGE

See Also:

Constant Field Values

Constructor Detail

CashManagementAction

public CashManagementAction()

Default constructor

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 to call super, but also make sure the helpers are populated.

Overrides:

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

Throws:

Exception

See Also:

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

createDocument

protected void createDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase)
                       throws org.kuali.rice.kew.exception.WorkflowException

Overrides the default document-creation code to auto-save new documents upon creation: since creating a CMDoc changes the CashDrawer's state as a side-effect, we need all CMDocs to be docsearchable so that someone can relocate and use or cancel whatever the current CMDoc is.

Overrides:

createDocument in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

Parameters:

kualiDocumentFormBase -

Throws:

org.kuali.rice.kew.exception.WorkflowException

addInterimDeposit

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

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

addFinalDeposit

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

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

checkDepositAuthorization

protected void checkDepositAuthorization(CashManagementForm cmForm,
                                         CashManagementDocument cmDoc)

Throws a DocumentAuthorizationException if the current user is not authorized to add a deposit of the given type to the given document.

Parameters:

cmDoc -

cmForm -

buildDepositWizardUrl

protected String buildDepositWizardUrl(CashManagementDocument cmDoc,
                                       String depositTypeCode)

Parameters:

cmDoc -

depositTypeCode -

Returns:

URL for passing control to the DepositWizard

cancelDeposit

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

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

reload

public org.apache.struts.action.ActionForward reload(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:

reload in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

Throws:

Exception

See Also:

KualiDocumentActionBase.reload(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

refreshSummary

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

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

openCashDrawer

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

Saves the document, then opens the cash drawer

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

finalizeLastInterimDeposit

public org.apache.struts.action.ActionForward finalizeLastInterimDeposit(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 action makes the last interim deposit a final deposit

Parameters:

mapping - the mapping of the actions

form - the Struts form populated on the post

request - the servlet request

response - the servlet response

Returns:

a forward to the same page we were on

Throws:

Exception - because you never know when something just might go wrong

applyCashieringTransaction

public org.apache.struts.action.ActionForward applyCashieringTransaction(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 action applies the current cashiering transaction to the cash drawer

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

correctCashDrawer

public org.apache.struts.action.ActionForward correctCashDrawer(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 action allows the user to go to the cash drawer correction screen

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

buildCashDrawerCorrectionUrl

protected String buildCashDrawerCorrectionUrl(CashManagementDocument cmDoc)

Parameters:

cmDoc -

depositTypeCode -

Returns:

URL for passing control to the DepositWizard

addCheck

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

Adds Check instance created from the current "new check" line to the document

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

deleteCheck

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

Deletes the selected check (line) from the document

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

route

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

Overridden to clear the CashDrawerSummary info

Overrides:

route in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

Throws:

Exception

See Also:

KualiDocumentActionBase.route(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)