org.kuali.kra.web.struts.action

Class KraHoldingPageAction

java.lang.Object

org.apache.struts.action.Action

org.apache.struts.actions.BaseAction

org.apache.struts.actions.DispatchAction

org.kuali.rice.kns.web.struts.action.KualiAction

org.kuali.kra.web.struts.action.AbstractHoldingPageAction

org.kuali.kra.web.struts.action.KraHoldingPageAction

public class KraHoldingPageAction
extends AbstractHoldingPageAction

Checks to see whether the document specified in the session has completed its asynchronous processing and is ready to be reloaded.

Field Summary

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

Fields inherited from class org.apache.struts.actions.BaseAction

messages

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
KraHoldingPageAction()

Method Summary

Methods

Modifier and Type

Method and Description

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) If this method is invoked due to a simple refresh from the holding page JSP, and not because the user has clicked 'return to portal', then it will check if the 'current document' has completed its processing and if so it will return the back location for that document as given in the user session by the key Constants.HOLDING_PAGE_RETURN_LOCATION.

Methods inherited from class org.kuali.kra.web.struts.action.AbstractHoldingPageAction

getDocumentService, getPersonService, isDocumentPostprocessingComplete, isPessimisticallyLocked, isProcessComplete, returnToPortal, setDocumentService, setPersonService

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

addMethodToCallToUncheckedList, checkAuthorization, defaultDispatch, dispatchMethod, doProcessingAfterPost, findMethodToCall, getApplicationBaseUrl, getBusinessObjectAuthorizationService, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, hideAllTabs, isModuleLocked, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, refresh, retrieveLookupParameterValue, showAllTabs, toggleTab, 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, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, 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

KraHoldingPageAction

public KraHoldingPageAction()

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

If this method is invoked due to a simple refresh from the holding page JSP, and not because the user has clicked 'return to portal', then it will check if the 'current document' has completed its processing and if so it will return the back location for that document as given in the user session by the key Constants.HOLDING_PAGE_RETURN_LOCATION. The 'current document' is the one that is obtained via the document service using the doc id provided in the session. By default this method will get this doc id from the top-level http session using the key KNSConstants.DOCUMENT_HTTP_SESSION_KEY. However, if you want a different doc id to be used, then before calling this method, then the following two steps must be performed: 1. insert the alternate doc id in the user session with some key constant, say 'X'. 2. insert 'X' also into the user session using the key Constants.ALTERNATE_DOC_ID_SESSION_KEY. Basically, this method performs double indirection on the user session key. It will first check if the user session key Constants.ALTERNATE_DOC_ID_SESSION_KEY has any value inserted for it, and if so will use that value again as a key into the user session to get the alternate doc id (and then use that doc id to obtain the document from the doc service).

Overrides:

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

Throws:

Exception

See Also:

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