org.kuali.kfs.module.purap.document.web.struts
Class VendorCreditMemoAction

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.sys.web.struts.KualiAccountingDocumentActionBase
                              org.kuali.kfs.module.purap.document.web.struts.PurchasingAccountsPayableActionBase
                                  org.kuali.kfs.module.purap.document.web.struts.AccountsPayableActionBase
                                      org.kuali.kfs.module.purap.document.web.struts.VendorCreditMemoAction

public class VendorCreditMemoAction
extends AccountsPayableActionBase

Struts Action for Credit Memo document.

Field Summary

protected static org.apache.log4j.Logger

LOG

Fields inherited from class org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase

UPDATE_EVENT_ACTIONS

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

VendorCreditMemoAction()

Method Summary

org.apache.struts.action.ActionForward	addHoldOnCreditMemo(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Puts a credit memo on hold, prompting for a reason before hand.
org.apache.struts.action.ActionForward	clearInitFields(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clears out fields of the 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 credit memo.
protected void	customCalculate(PurchasingAccountsPayableDocument apDoc) Calls methods to perform credit allowed calculation and total credit memo amount.
String	getActionName() Returns the current action name.
protected org.apache.struts.action.ActionForward	performDuplicateCreditMemoCheck(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, VendorCreditMemoDocument creditMemoDocument) Calls CreditMemoService to perform the duplicate credit memo check.
protected void	populateAdHocActionRequestCodes(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase)
org.apache.struts.action.ActionForward	removeHoldFromCreditMemo(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Removes a hold on the credit memo.

Methods inherited from class org.kuali.kfs.module.purap.document.web.struts.AccountsPayableActionBase

askCancelQuestion, askQuestionsAndPerformReopenPurchaseOrder, askQuestionWithInput, askQuestionWithInput, calculate, cancel, cancelCallbackMethod, cancelPOActionCallbackMethod, clearAllTaxes, execute, getQuestionProperty, initiateReopenPurchaseOrder, loadDocument, refresh, reopenPo, requiresCaculate, route, save

Methods inherited from class org.kuali.kfs.module.purap.document.web.struts.PurchasingAccountsPayableActionBase

customAccountRetrieval, deleteSourceLine, downloadBOAttachment, getSelectedLineForAccounts, getSourceAccountingLine, hideAllAccounts, insertAccountingLine, insertAccountingLine, insertBONote, insertSourceLine, processAccountingLineOverrides, processCustomInsertAccountingLine, refreshAccountSummary, showAllAccounts, updateBaseline, uploadAccountingLines

Methods inherited from class org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase

addCapitalAssetInfo, addCapitalAssetInfoDetailLines, applyCapitalAssetInformation, approve, blanketApprove, checkSalesTax, checkSalesTaxRequiredAllLines, checkUploadFile, clearCapitalAssetInfo, clearOverridesThatBecameUnneeded, copy, deepCopyAccountingLinesList, deleteAccountingLine, deleteCapitalAssetInfoDetailLine, deleteTargetLine, getCurrentCapitalAssetInformationObject, getMaxItemLineNumber, getNextItemLineNumberAndIncremented, getObjectTypeCodeFromLine, getTargetAccountingLine, handleSalesTaxRequired, handleSalesTaxRequiredAllLines, hasSalesTaxBeenEntered, hideDetails, insertAccountingLine, insertTargetLine, isSalesTaxRequired, isValidSalesTaxEntered, performBalanceInquiryForAccountingLine, performBalanceInquiryForSourceLine, performBalanceInquiryForTargetLine, performLookup, populateSalesTax, processAccountingLineOverrides, processAccountingLineOverrides, processAccountingLines, refreshSalesTaxInfo, removeSalesTax, resetCapitalAssetInfo, showDetails, toggleTab, uploadSourceLines, uploadTargetLines

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

populateAuthorizationFields

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

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

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

Constructor Detail

VendorCreditMemoAction

public VendorCreditMemoAction()

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 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)

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 indicates whether the type is payment request, purchase order, or vendor. Based on that, the credit memo is initially populated and the remaining tabs shown.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

clearInitFields

public org.apache.struts.action.ActionForward clearInitFields(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 fields of the init tab.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

performDuplicateCreditMemoCheck

protected org.apache.struts.action.ActionForward performDuplicateCreditMemoCheck(org.apache.struts.action.ActionMapping mapping,
                                                                                 org.apache.struts.action.ActionForm form,
                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                 javax.servlet.http.HttpServletResponse response,
                                                                                 VendorCreditMemoDocument creditMemoDocument)
                                                                          throws Exception

Calls CreditMemoService to perform the duplicate credit memo check. If one is found, a question is setup and control is forwarded to the question action method. Coming back from the question prompt, the button that was clicked is checked, and if 'no' was selected, they are forward back to the page still in init mode.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

creditMemoDocument - The CreditMemoDocument

Returns:

An ActionForward

Throws:

Exception

See Also:

CreditMemoService

customCalculate

protected void customCalculate(PurchasingAccountsPayableDocument apDoc)

Calls methods to perform credit allowed calculation and total credit memo amount.

Overrides:

customCalculate in class PurchasingAccountsPayableActionBase

Parameters:

apDoc - An AccountsPayableDocument

addHoldOnCreditMemo

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

Puts a credit memo on hold, prompting for a reason before hand. This stops further approvals or routing.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

removeHoldFromCreditMemo

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

Removes a hold on the credit memo.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

getActionName

public String getActionName()

Description copied from class: AccountsPayableActionBase

Returns the current action name.

Overrides:

getActionName in class AccountsPayableActionBase

Returns:

A String. Set to null!

See Also:

AccountsPayableActionBase.getActionName()

populateAdHocActionRequestCodes

protected void populateAdHocActionRequestCodes(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase)

Overrides:

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