|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public abstract class KualiAction
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.
Field Summary | |
---|---|
static String |
FORM_ACTION
Constant defined to match with TextArea.jsp and updateTextArea function in core.js |
static String |
FORWARD_NEXT
Constant defined to match with local forwarding in struts-config.xml for the parent of the Updated Text Area. |
static String |
FORWARD_TEXT_AREA_UPDATE
Constant defined to match with global forwarding in struts-config.xml for Text Area Update. |
static String |
METHOD_TO_CALL
Constant defined to match input parameter from URL and from TextArea.jsp. |
static String |
MODULE_LOCKED_MESSAGE
Constant defined to match with method call in module-locked.jsp which is set to a message that is displayed when the module is locked. |
static String |
POST_TEXT_AREA_TO_PARENT
Constant defined to match with method to call in TextArea.jsp. |
static String |
TEXT_AREA_FIELD_ANCHOR
Constant defined to match with TextArea.jsp and updateTextArea function in core.js |
static String |
TEXT_AREA_FIELD_LABEL
Constant defined to match with TextArea.jsp and updateTextArea function in core.js |
static String |
TEXT_AREA_FIELD_NAME
Constant defined to match with TextArea.jsp and updateTextArea function in core.js |
static String |
TEXT_AREA_MAX_LENGTH
Constant defined to match with TextArea.jsp and updateTextArea function in core.js |
static String |
TEXT_AREA_READ_ONLY
Constant defined to match with TextArea.jsp and updateTextArea function in core.js |
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 | |
---|---|
KualiAction()
|
Method Summary | |
---|---|
protected void |
addMethodToCallToUncheckedList(String methodToCall)
Use to add a methodToCall to the a list which will not have authorization checks. |
protected void |
checkAuthorization(org.apache.struts.action.ActionForm form,
String methodToCall)
Override this method to provide action-level access controls to the application. |
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)
When no methodToCall is specified, the defaultDispatch method is invoked. |
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)
|
protected void |
doProcessingAfterPost(KualiForm form,
javax.servlet.http.HttpServletRequest request)
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.ActionForward |
execute(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Entry point to all actions. |
protected String |
findMethodToCall(org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request)
|
static String |
getApplicationBaseUrl()
|
protected BusinessObjectAuthorizationService |
getBusinessObjectAuthorizationService()
|
protected EncryptionService |
getEncryptionService()
|
protected String |
getHeaderTabDispatch(javax.servlet.http.HttpServletRequest request)
Retrieves the header tab dispatch. |
protected String |
getHeaderTabNavigateTo(javax.servlet.http.HttpServletRequest request)
Retrieves the header tab to navigate to. |
protected String |
getImageContext(javax.servlet.http.HttpServletRequest request,
String contextKey)
Retrieves the image context |
protected static KualiModuleService |
getKualiModuleService()
|
protected int |
getLineToDelete(javax.servlet.http.HttpServletRequest request)
Parses the method to call attribute to pick off the line number which should be deleted. |
protected String |
getReturnLocation(javax.servlet.http.HttpServletRequest request,
org.apache.struts.action.ActionMapping mapping)
|
protected Map<String,String> |
getRoleQualification(org.apache.struts.action.ActionForm form,
String methodToCall)
override this method to add data from the form for role qualification in the authorization check |
protected int |
getSelectedLine(javax.servlet.http.HttpServletRequest request)
Parses the method to call attribute to pick off the line number which should have an action performed on it. |
protected String |
getTabToToggle(javax.servlet.http.HttpServletRequest request)
Determines which tab was requested to be toggled |
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)
Handles requests that originate via Header Tabs. |
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)
Toggles all tabs to closed |
protected boolean |
isModuleLocked(org.apache.struts.action.ActionForm form,
String methodToCall,
javax.servlet.http.HttpServletRequest request)
|
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)
|
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)
Takes care of storing the action form in the User session and forwarding to the lookup action. |
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)
Handles rendering a question prompt - without a specified context. |
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)
Handles re-rendering a question prompt because of an error on what was submitted. |
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)
This method handles rendering the question component, but without any of the extra error fields |
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)
Takes care of storing the action form in the User session and forwarding to the workflow workgroup lookup action. |
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)
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.ActionForward |
refresh(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Default refresh method. |
protected String |
retrieveLookupParameterValue(Class<? extends BusinessObject> boClass,
String parameterName,
String parameterValuePropertyName,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request)
Retrieves the value of a parameter to be passed into the lookup or inquiry frameworks. |
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)
Toggles all tabs to open |
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)
Toggles the tab state in the ui |
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)
This method is invoked when Java Script is turned off from the web browser. |
protected void |
validateLookupInquiryFullParameter(javax.servlet.http.HttpServletRequest request,
org.apache.struts.action.ActionForm form,
String fullParameter)
|
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 |
Field Detail |
---|
public static final String TEXT_AREA_FIELD_NAME
Value is textAreaFieldName
public static final String TEXT_AREA_FIELD_LABEL
Value is textAreaFieldLabel
public static final String TEXT_AREA_READ_ONLY
Value is textAreaReadOnly
public static final String TEXT_AREA_FIELD_ANCHOR
Value is textAreaFieldAnchor
public static final String TEXT_AREA_MAX_LENGTH
Value is textAreaFieldAnchor
public static final String FORM_ACTION
Value is htmlFormAction
public static final String METHOD_TO_CALL
Value is methodToCall
public static final String FORWARD_TEXT_AREA_UPDATE
Value is updateTextArea
public static final String POST_TEXT_AREA_TO_PARENT
Value is postTextAreaToParent
public static final String FORWARD_NEXT
Value is forwardNext
public static final String MODULE_LOCKED_MESSAGE
Constructor Detail |
---|
public KualiAction()
Method Detail |
---|
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
execute
in class org.apache.struts.actions.DispatchAction
Exception
Action.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm,
javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
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
Exception
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
dispatchMethod
in class org.apache.struts.actions.DispatchAction
Exception
protected String findMethodToCall(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request) throws Exception
Exception
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
mapping
- form
- request
- response
-
Exception
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
mapping
- form
- request
- response
-
Exception
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
mapping
- form
- request
- response
-
Exception
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
mapping
- form
- request
- response
-
Exception
protected int getLineToDelete(javax.servlet.http.HttpServletRequest request)
request
-
protected int getSelectedLine(javax.servlet.http.HttpServletRequest request)
request
-
protected String getTabToToggle(javax.servlet.http.HttpServletRequest request)
request
-
protected String getHeaderTabNavigateTo(javax.servlet.http.HttpServletRequest request)
request
-
protected String getHeaderTabDispatch(javax.servlet.http.HttpServletRequest request)
request
-
protected String getImageContext(javax.servlet.http.HttpServletRequest request, String contextKey)
request
- contextKey
-
protected String getReturnLocation(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMapping mapping)
protected String retrieveLookupParameterValue(Class<? extends BusinessObject> boClass, String parameterName, String parameterValuePropertyName, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request) throws Exception
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 foundform
- request
-
Exception
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
mapping
- form
- request
- response
-
Exception
protected void validateLookupInquiryFullParameter(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForm form, String fullParameter)
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
Exception
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
mapping
- form
- request
- response
- questionId
- questionText
- questionType
- caller
- context
-
Exception
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
mapping
- form
- request
- response
- questionId
- questionText
- questionType
- caller
- context
-
Exception
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
mapping
- form
- request
- response
- questionId
- questionText
- questionType
- caller
- context
- reason
- errorKey
- errorPropertyName
- errorParameter
-
Exception
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
mapping
- form
- request
- response
-
Exception
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
mapping
- form
- request
- response
-
Exception
protected void checkAuthorization(org.apache.struts.action.ActionForm form, String methodToCall) throws AuthorizationException
form
-
AuthorizationException
protected Map<String,String> getRoleQualification(org.apache.struts.action.ActionForm form, String methodToCall)
protected static KualiModuleService getKualiModuleService()
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)
mapping
- form
- request
- response
-
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)
mapping
- form
- request
- response
-
protected final void addMethodToCallToUncheckedList(String methodToCall)
protected void doProcessingAfterPost(KualiForm form, javax.servlet.http.HttpServletRequest request)
protected BusinessObjectAuthorizationService getBusinessObjectAuthorizationService()
protected EncryptionService getEncryptionService()
public static String getApplicationBaseUrl()
protected boolean isModuleLocked(org.apache.struts.action.ActionForm form, String methodToCall, javax.servlet.http.HttpServletRequest request)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |