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

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.module.ar.document.web.struts.CustomerCreditMemoDocumentAction

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

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

CustomerCreditMemoDocumentAction()

Method Summary

org.apache.struts.action.ActionForward	clearInitTab(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clears out init tab.
org.apache.struts.action.ActionForward	continueCreditMemo(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles continue request.
protected void	createDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase) Do initialization for a new customer credit memo.
protected String	getUrlForPrintCreditMemo(String basePath, String docId, String methodToCall) Creates a URL to be used in printing the customer credit memo.
protected void	loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase) This method loads the document by its provided document header id.
org.apache.struts.action.ActionForward	print(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method...
org.apache.struts.action.ActionForward	printCreditMemoPDF(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method...
org.apache.struts.action.ActionForward	recalculateCustomerCreditMemoDetail(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Based on user input this method recalculates a customer credit memo detail
org.apache.struts.action.ActionForward	recalculateCustomerCreditMemoDocument(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Based on user input this method recalculates customer credit memo document <=> all customer credit memo details
org.apache.struts.action.ActionForward	refreshCustomerCreditMemoDetail(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method refreshes a customer credit memo detail
org.apache.struts.action.ActionForward	refreshCustomerCreditMemoDocument(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method refreshes customer credit memo details and line with totals

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, execute, 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

CustomerCreditMemoDocumentAction

public CustomerCreditMemoDocumentAction()

Method Detail

createDocument

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

Do initialization for a new customer credit memo.

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)

loadDocument

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

This method loads the document by its provided document header id. This has been abstracted out so that it can be overridden in children if the need arises.

Overrides:

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

Parameters:

kualiDocumentFormBase -

Throws:

org.kuali.rice.kew.exception.WorkflowException

clearInitTab

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

Clears out init tab.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

continueCreditMemo

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

Handles continue request. This request comes from the initial screen which gives ref. invoice number. Based on that, the customer credit memo is initially populated.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

recalculateCustomerCreditMemoDetail

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

Based on user input this method recalculates a customer credit memo detail

Parameters:

mapping - action mapping

form - action form

request -

response -

Returns:

action forward

Throws:

Exception

refreshCustomerCreditMemoDetail

public org.apache.struts.action.ActionForward refreshCustomerCreditMemoDetail(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 refreshes a customer credit memo detail

Parameters:

mapping - action mapping

form - action form

request -

response -

Returns:

action forward

Throws:

Exception

refreshCustomerCreditMemoDocument

public org.apache.struts.action.ActionForward refreshCustomerCreditMemoDocument(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 refreshes customer credit memo details and line with totals

Parameters:

mapping - action mapping

form - action form

request -

response -

Returns:

action forward

Throws:

Exception

recalculateCustomerCreditMemoDocument

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

Based on user input this method recalculates customer credit memo document <=> all customer credit memo details

Parameters:

mapping - action mapping

form - action form

request -

response -

Returns:

action forward

Throws:

Exception

print

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

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

printCreditMemoPDF

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

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

getUrlForPrintCreditMemo

protected String getUrlForPrintCreditMemo(String basePath,
                                          String docId,
                                          String methodToCall)

Creates a URL to be used in printing the customer credit memo.

Parameters:

basePath - String: The base path of the current URL

docId - String: The document ID of the document to be printed

methodToCall - String: The name of the method that will be invoked to do this particular print

Returns:

The URL