Class KualiAction
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
- Direct Known Subclasses:
KualiDocumentActionBase,KualiFeedbackHandlerAction,KualiHelpAction,KualiInquiryAction,KualiLookupAction,QuestionPromptAction
Deprecated.
KNS Struts deprecated, use KRAD and the Spring MVC framework.
The base Action class for all KNS-based Actions. Extends from the standard
DispatchAction which allows for a methodToCall request parameter to
be used to indicate which method to invoke.
This Action overrides #execute to set methodToCall for image submits. Also performs other setup required for KNS framework calls.
- Author:
- Kuali Rice Team (rice.collab@kuali.org)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsstatic final StringDeprecated.Constant defined to match with local forwarding in struts-config.xml for the parent of the Updated Text Area.static final StringDeprecated.Constant defined to match with global forwarding in struts-config.xml for Text Area Update.static final StringDeprecated.Constant defined to match input parameter from URL and from TextArea.jsp.static final StringDeprecated.Constant defined to match with method to call in TextArea.jsp.static final StringDeprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsstatic final StringDeprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsstatic final StringDeprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsstatic final StringDeprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsstatic final StringDeprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsFields inherited from class org.apache.struts.actions.DispatchAction
clazz, log, methods, typesFields inherited from class org.apache.struts.actions.BaseAction
messagesFields inherited from class org.apache.struts.action.Action
servlet -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected final voidaddMethodToCallToUncheckedList(String methodToCall) Deprecated.Use to add a methodToCall to the a list which will not have authorization checks.protected voidcheckAuthorization(org.apache.struts.action.ActionForm form, String methodToCall) Deprecated.Override this method to provide action-level access controls to the application.protected org.apache.struts.action.ActionForwarddefaultDispatch(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.When no methodToCall is specified, the defaultDispatch method is invoked.protected org.apache.struts.action.ActionForwarddispatchMethod(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String methodToCall) Deprecated.protected voiddoProcessingAfterPost(KualiForm form, javax.servlet.http.HttpServletRequest request) Deprecated.This method does all special processing on a document that should happen on each HTTP post (ie, save, route, approve, etc).org.apache.struts.action.ActionForwardexecute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.Entry point to all actions.protected StringfindMethodToCall(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request) Deprecated.static StringDeprecated.protected BusinessObjectAuthorizationServiceDeprecated.protected org.kuali.rice.core.api.encryption.EncryptionServiceDeprecated.protected StringgetHeaderTabDispatch(javax.servlet.http.HttpServletRequest request) Deprecated.Retrieves the header tab dispatch.protected StringgetHeaderTabNavigateTo(javax.servlet.http.HttpServletRequest request) Deprecated.Retrieves the header tab to navigate to.protected StringgetImageContext(javax.servlet.http.HttpServletRequest request, String contextKey) Deprecated.Retrieves the image context.protected static org.kuali.rice.krad.service.KualiModuleServiceDeprecated.protected intgetLineToDelete(javax.servlet.http.HttpServletRequest request) Deprecated.Parses the method to call attribute to pick off the line number which should be deleted.protected intgetLineToEdit(javax.servlet.http.HttpServletRequest request) Deprecated.Parses the method to call attribute to pick off the line number which should be edited.protected StringgetReturnLocation(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMapping mapping) Deprecated.getRoleQualification(org.apache.struts.action.ActionForm form, String methodToCall) Deprecated.override this method to add data from the form for role qualification in the authorization checkprotected intgetSelectedLine(javax.servlet.http.HttpServletRequest request) Deprecated.Parses the method to call attribute to pick off the line number which should have an action performed on it.protected StringgetTabToToggle(javax.servlet.http.HttpServletRequest request) Deprecated.Determines which tab was requested to be toggled.org.apache.struts.action.ActionForwardheaderTab(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.Handles requests that originate via Header Tabs.org.apache.struts.action.ActionForwardhideAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.Toggles all tabs to closedprotected booleanisModuleLocked(org.apache.struts.action.ActionForm form, String methodToCall, javax.servlet.http.HttpServletRequest request) Deprecated.org.apache.struts.action.ActionForwardperformInquiry(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.org.apache.struts.action.ActionForwardperformLookup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.Takes care of storing the action form in the User session and forwarding to the lookup action.protected org.apache.struts.action.ActionForwardperformQuestionWithInput(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String questionText, String questionType, String caller, String context) Deprecated.Handles rendering a question prompt - without a specified context.protected org.apache.struts.action.ActionForwardperformQuestionWithInputAgainBecauseOfErrors(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String questionText, String questionType, String caller, String context, String reason, String errorKey, String errorPropertyName, String errorParameter) Deprecated.Handles re-rendering a question prompt because of an error on what was submitted.protected org.apache.struts.action.ActionForwardperformQuestionWithoutInput(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String questionText, String questionType, String caller, String context) Deprecated.This method handles rendering the question component, but without any of the extra error fields.org.apache.struts.action.ActionForwardperformWorkgroupLookup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.Takes care of storing the action form in the User session and forwarding to the workflow workgroup lookup action.org.apache.struts.action.ActionForwardpostTextAreaToParent(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.This method is invoked from the TextArea.jsp for posting its value to the parent page that called the extended text area page.org.apache.struts.action.ActionForwardrefresh(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.Default refresh method.protected StringretrieveLookupParameterValue(Class<? extends org.kuali.rice.krad.bo.BusinessObject> boClass, String parameterName, String parameterValuePropertyName, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request) Deprecated.Retrieves the value of a parameter to be passed into the lookup or inquiry frameworks.org.apache.struts.action.ActionForwardshowAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.Toggles all tabs to openorg.apache.struts.action.ActionForwardtoggleTab(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.Toggles the tab state in the uiorg.apache.struts.action.ActionForwardupdateTextArea(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.This method is invoked when Java Script is turned off from the web browser.protected voidvalidateLookupInquiryFullParameter(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForm form, String fullParameter) Deprecated.Methods inherited from class org.apache.struts.actions.DispatchAction
cancelled, getMethod, getMethodName, getParameter, unspecifiedMethods 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
-
Field Details
-
TEXT_AREA_FIELD_NAME
Deprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsValue is textAreaFieldName
- See Also:
-
TEXT_AREA_FIELD_LABEL
Deprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsValue is textAreaFieldLabel
- See Also:
-
TEXT_AREA_READ_ONLY
Deprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsValue is textAreaReadOnly
- See Also:
-
TEXT_AREA_FIELD_ANCHOR
Deprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsValue is textAreaFieldAnchor
- See Also:
-
TEXT_AREA_MAX_LENGTH
Deprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsValue is textAreaFieldAnchor
- See Also:
-
FORM_ACTION
Deprecated.Constant defined to match with TextArea.jsp and updateTextArea function in core.jsValue is htmlFormAction
- See Also:
-
METHOD_TO_CALL
Deprecated.Constant defined to match input parameter from URL and from TextArea.jsp.Value is methodToCall
- See Also:
-
FORWARD_TEXT_AREA_UPDATE
Deprecated.Constant defined to match with global forwarding in struts-config.xml for Text Area Update.Value is updateTextArea
- See Also:
-
POST_TEXT_AREA_TO_PARENT
Deprecated.Constant defined to match with method to call in TextArea.jsp.Value is postTextAreaToParent
- See Also:
-
FORWARD_NEXT
Deprecated.Constant defined to match with local forwarding in struts-config.xml for the parent of the Updated Text Area.Value is forwardNext
- See Also:
-
-
Constructor Details
-
KualiAction
public KualiAction()Deprecated.
-
-
Method Details
-
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 Deprecated.Entry point to all actions. NOTE: No need to hook into execute for handling framework setup anymore. Just implement the methodToCall for the framework setup, Constants.METHOD_REQUEST_PARAMETER will contain the full parameter, which can be sub stringed for getting framework parameters.- Overrides:
executein classorg.apache.struts.actions.DispatchAction- Throws:
Exception- See Also:
-
defaultDispatch
protected org.apache.struts.action.ActionForward defaultDispatch(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception Deprecated.When no methodToCall is specified, the defaultDispatch method is invoked. Default implementation returns the "basic" ActionForward.- Throws:
Exception
-
dispatchMethod
protected org.apache.struts.action.ActionForward dispatchMethod(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String methodToCall) throws Exception Deprecated.- Overrides:
dispatchMethodin classorg.apache.struts.actions.DispatchAction- Throws:
Exception
-
findMethodToCall
protected String findMethodToCall(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request) throws Exception Deprecated.- Throws:
Exception
-
toggleTab
public org.apache.struts.action.ActionForward toggleTab(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception Deprecated.Toggles the tab state in the ui- Throws:
Exception
-
showAllTabs
public org.apache.struts.action.ActionForward showAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception Deprecated.Toggles all tabs to open- Throws:
Exception
-
hideAllTabs
public org.apache.struts.action.ActionForward hideAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception Deprecated.Toggles all tabs to closed- Throws:
Exception
-
refresh
public org.apache.struts.action.ActionForward refresh(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception Deprecated.Default refresh method. Called from returning frameworks.- Throws:
Exception
-
getLineToDelete
protected int getLineToDelete(javax.servlet.http.HttpServletRequest request) Deprecated.Parses the method to call attribute to pick off the line number which should be deleted. -
getLineToEdit
protected int getLineToEdit(javax.servlet.http.HttpServletRequest request) Deprecated.Parses the method to call attribute to pick off the line number which should be edited. -
getSelectedLine
protected int getSelectedLine(javax.servlet.http.HttpServletRequest request) Deprecated.Parses the method to call attribute to pick off the line number which should have an action performed on it. -
getTabToToggle
Deprecated.Determines which tab was requested to be toggled. -
getHeaderTabDispatch
Deprecated.Retrieves the header tab dispatch. -
getImageContext
Deprecated.Retrieves the image context. -
getReturnLocation
protected String getReturnLocation(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMapping mapping) Deprecated. -
retrieveLookupParameterValue
protected String retrieveLookupParameterValue(Class<? extends org.kuali.rice.krad.bo.BusinessObject> boClass, String parameterName, String parameterValuePropertyName, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request) throws Exception Deprecated.Retrieves the value of a parameter to be passed into the lookup or inquiry frameworks. The default implementation of this method will attempt to look in the request to determine wheter the appropriate value exists as a request parameter. If not, it will attempt to look through the form object to find the property.- Parameters:
boClass- a class implementing boClass, representing the BO that will be looked upparameterName- the name of the parameterparameterValuePropertyName- the property (relative to the form object) where the value to be passed into the lookup/inquiry may be found- Throws:
Exception
-
performLookup
public org.apache.struts.action.ActionForward performLookup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception Deprecated.Takes care of storing the action form in the User session and forwarding to the lookup action.- Throws:
Exception
-
validateLookupInquiryFullParameter
protected void validateLookupInquiryFullParameter(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForm form, String fullParameter) Deprecated. -
performInquiry
public org.apache.struts.action.ActionForward performInquiry(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception Deprecated.- Throws:
Exception
-
performQuestionWithoutInput
protected org.apache.struts.action.ActionForward performQuestionWithoutInput(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String questionText, String questionType, String caller, String context) throws Exception Deprecated.This method handles rendering the question component, but without any of the extra error fields.- Throws:
Exception
-
performQuestionWithInput
protected org.apache.struts.action.ActionForward performQuestionWithInput(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String questionText, String questionType, String caller, String context) throws Exception Deprecated.Handles rendering a question prompt - without a specified context.- Throws:
Exception
-
performQuestionWithInputAgainBecauseOfErrors
protected org.apache.struts.action.ActionForward performQuestionWithInputAgainBecauseOfErrors(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String questionText, String questionType, String caller, String context, String reason, String errorKey, String errorPropertyName, String errorParameter) throws Exception Deprecated.Handles re-rendering a question prompt because of an error on what was submitted.- Throws:
Exception
-
performWorkgroupLookup
public org.apache.struts.action.ActionForward performWorkgroupLookup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception Deprecated.Takes care of storing the action form in the User session and forwarding to the workflow workgroup lookup action.- Throws:
Exception
-
headerTab
public org.apache.struts.action.ActionForward headerTab(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception Deprecated.Handles requests that originate via Header Tabs.- Throws:
Exception
-
checkAuthorization
protected void checkAuthorization(org.apache.struts.action.ActionForm form, String methodToCall) throws org.kuali.rice.krad.exception.AuthorizationException Deprecated.Override this method to provide action-level access controls to the application.- Throws:
org.kuali.rice.krad.exception.AuthorizationException
-
getRoleQualification
protected Map<String,String> getRoleQualification(org.apache.struts.action.ActionForm form, String methodToCall) Deprecated.override this method to add data from the form for role qualification in the authorization check -
getKualiModuleService
protected static org.kuali.rice.krad.service.KualiModuleService getKualiModuleService()Deprecated. -
updateTextArea
public org.apache.struts.action.ActionForward updateTextArea(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.This method is invoked when Java Script is turned off from the web browser. It setup the information that the update text area requires for copying current text in the calling page text area and returning to the calling page. The information is passed to the JSP through Http Request attributes. All other parameters are forwarded. -
postTextAreaToParent
public org.apache.struts.action.ActionForward postTextAreaToParent(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.This method is invoked from the TextArea.jsp for posting its value to the parent page that called the extended text area page. The invocation is done through Struts action. The default forwarding id is RiceContants.MAPPING_BASIC. This can be overridden using the parameter key FORWARD_NEXT. -
addMethodToCallToUncheckedList
Deprecated.Use to add a methodToCall to the a list which will not have authorization checks. This assumes that the call will be redirected (as in the case of a lookup) that will perform the authorization. -
doProcessingAfterPost
Deprecated.This method does all special processing on a document that should happen on each HTTP post (ie, save, route, approve, etc). -
getBusinessObjectAuthorizationService
Deprecated. -
getEncryptionService
protected org.kuali.rice.core.api.encryption.EncryptionService getEncryptionService()Deprecated. -
getApplicationBaseUrl
Deprecated. -
isModuleLocked
protected boolean isModuleLocked(org.apache.struts.action.ActionForm form, String methodToCall, javax.servlet.http.HttpServletRequest request) Deprecated.
-