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

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.purap.document.web.struts.ReceivingBaseAction

Direct Known Subclasses:

CorrectionReceivingAction, LineItemReceivingAction

public class ReceivingBaseAction
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

ReceivingBaseAction()

Method Summary

protected org.apache.struts.action.ActionForward	askQuestionWithInput(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionType, String notePrefix, String operation, String messageKey, ReceivingQuestionCallback callback) A wrapper method which prompts for a reason to hold a payment request or credit memo.
protected org.apache.struts.action.ActionForward	askQuestionWithInput(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionType, String notePrefix, String operation, String messageKey, TreeMap<String,ReceivingQuestionCallback> questionsAndCallbacks, String messagePrefix, org.apache.struts.action.ActionForward redirect) Builds and asks questions which require text input by the user for a payment request or a credit memo.
protected String	getQuestionProperty(String messageKey, String messagePrefix, org.kuali.rice.kns.service.KualiConfigurationService kualiConfiguration, String question) Used to look up messages to be displayed, from the KualiConfigurationService, given either a whole key or two parts of a key that may be concatenated together.

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, cancel, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, close, combineAdHocRecipients, convertSetToMap, createDocument, 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, loadDocument, 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

ReceivingBaseAction

public ReceivingBaseAction()

Method Detail

askQuestionWithInput

protected org.apache.struts.action.ActionForward askQuestionWithInput(org.apache.struts.action.ActionMapping mapping,
                                                                      org.apache.struts.action.ActionForm form,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response,
                                                                      String questionType,
                                                                      String notePrefix,
                                                                      String operation,
                                                                      String messageKey,
                                                                      ReceivingQuestionCallback callback)
                                                               throws Exception

A wrapper method which prompts for a reason to hold a payment request or credit memo.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

questionType - A String used to distinguish which question is being asked

notePrefix - A String explaining what action was taken, to be prepended to the note containing the reason, which gets written to the document

operation - A one-word String description of the action to be taken, to be substituted into the message. (Can be an empty String for some messages.)

messageKey - A key to the message which will appear on the question screen

callback - A PurQuestionCallback

Returns:

An ActionForward

Throws:

Exception

askQuestionWithInput

protected org.apache.struts.action.ActionForward askQuestionWithInput(org.apache.struts.action.ActionMapping mapping,
                                                                      org.apache.struts.action.ActionForm form,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response,
                                                                      String questionType,
                                                                      String notePrefix,
                                                                      String operation,
                                                                      String messageKey,
                                                                      TreeMap<String,ReceivingQuestionCallback> questionsAndCallbacks,
                                                                      String messagePrefix,
                                                                      org.apache.struts.action.ActionForward redirect)
                                                               throws Exception

Builds and asks questions which require text input by the user for a payment request or a credit memo.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

questionType - A String used to distinguish which question is being asked

notePrefix - A String explaining what action was taken, to be prepended to the note containing the reason, which gets written to the document

operation - A one-word String description of the action to be taken, to be substituted into the message. (Can be an empty String for some messages.)

messageKey - A (whole) key to the message which will appear on the question screen

questionsAndCallbacks - A TreeMap associating the type of question to be asked and the type of callback which should happen in that case

messagePrefix - The most general part of a key to a message text to be retrieved from KualiConfigurationService, Describes a collection of questions.

redirect - An ActionForward to return to if done with questions

Returns:

An ActionForward

Throws:

Exception

getQuestionProperty

protected String getQuestionProperty(String messageKey,
                                     String messagePrefix,
                                     org.kuali.rice.kns.service.KualiConfigurationService kualiConfiguration,
                                     String question)

Used to look up messages to be displayed, from the KualiConfigurationService, given either a whole key or two parts of a key that may be concatenated together.

Parameters:

messageKey - String. One of the message keys in PurapKeyConstants.

messagePrefix - String. A prefix to the question key, such as "ap.question." that, concatenated with the question, comprises the whole key of the message.

kualiConfiguration - An instance of KualiConfigurationService

question - String. The most specific part of the message key in PurapKeyConstants.

Returns:

The message to be displayed given the key