org.kuali.kfs.module.ar.document.web.struts
Class CashControlDocumentAction

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.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase
                          org.kuali.kfs.module.ar.document.web.struts.CashControlDocumentAction

public class CashControlDocumentAction
extends FinancialSystemTransactionalDocumentActionBase

Field Summary

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

CashControlDocumentAction()

Method Summary

org.apache.struts.action.ActionForward	addCashControlDetail(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method adds a new cash control detail
protected org.kuali.rice.kns.util.KualiDecimal	calculateCashControlTotal(CashControlDocument cashControlDocument) Recalculates the cash control total since user could have changed it during their update.
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)
protected boolean	cancelLinkedPaymentApplicationDocuments(CashControlDocument cashControlDocument) This method cancels all linked Payment Application documents that are not already in approved status.
protected void	createDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase)
org.apache.struts.action.ActionForward	deleteCashControlDetail(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method deletes a cash control detail
org.apache.struts.action.ActionForward	disapprove(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	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Adds handling for cash control detail amount updates.
org.apache.struts.action.ActionForward	generateGLPEs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method generates the GLPEs.
protected void	loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase)

Methods inherited from class org.kuali.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase

correct

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, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, close, combineAdHocRecipients, convertSetToMap, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, 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, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, refresh, refreshAdHocRoutingWorkgroupLookups, releaseLocks, reload, returnToSender, route, 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

Constructor Detail

CashControlDocumentAction

public CashControlDocumentAction()

Method Detail

loadDocument

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

Overrides:

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

Throws:

org.kuali.rice.kew.exception.WorkflowException

See Also:

KualiDocumentActionBase.loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)

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

Adds handling for cash control detail amount updates.

Overrides:

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

Throws:

Exception

See Also:

Action.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:

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

Throws:

org.kuali.rice.kew.exception.WorkflowException

See Also:

KualiDocumentActionBase.createDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)

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

Overrides:

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

Throws:

Exception

See Also:

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

disapprove

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

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

Throws:

Exception

See Also:

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

cancelLinkedPaymentApplicationDocuments

protected boolean cancelLinkedPaymentApplicationDocuments(CashControlDocument cashControlDocument)
                                                   throws org.kuali.rice.kew.exception.WorkflowException

This method cancels all linked Payment Application documents that are not already in approved status.

Parameters:

cashControlDocument -

Throws:

org.kuali.rice.kew.exception.WorkflowException

addCashControlDetail

public org.apache.struts.action.ActionForward addCashControlDetail(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 adds a new cash control detail

Parameters:

mapping - action mapping

form - action form

request -

response -

Returns:

forward action

Throws:

Exception

deleteCashControlDetail

public org.apache.struts.action.ActionForward deleteCashControlDetail(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 deletes a cash control detail

Parameters:

mapping - action mapping

form - action form

request -

response -

Returns:

action forward

Throws:

Exception

generateGLPEs

public org.apache.struts.action.ActionForward generateGLPEs(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 generates the GLPEs.

Parameters:

mapping - action mapping

form - action form

request -

response -

Returns:

action forward

Throws:

Exception

calculateCashControlTotal

protected org.kuali.rice.kns.util.KualiDecimal calculateCashControlTotal(CashControlDocument cashControlDocument)

Recalculates the cash control total since user could have changed it during their update.

Parameters:

cashControlDocument -