org.kuali.rice.kns.web.struts.action
Class KualiHelpAction

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.rice.kns.web.struts.action.KualiHelpAction

public class KualiHelpAction
extends KualiAction

This class handles requests for help text.

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

KualiHelpAction()

Method Summary

org.apache.struts.action.ActionForward	getAttributeHelpText(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves help information from the data dictionary for the business object attribute.
org.apache.struts.action.ActionForward	getAttributeHelpText(org.apache.struts.action.ActionMapping mapping, KualiHelpForm helpForm, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves help information from the data dictionary for the business object attribute.
org.apache.struts.action.ActionForward	getBusinessObjectHelpText(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves help information from the data dictionary for the document type.
protected String	getDefaultLookupHelpResourceKey()
org.apache.struts.action.ActionForward	getDocumentHelpText(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves help information from the data dictionary for the document type.
org.apache.struts.action.ActionForward	getHelpUrlByNamespace(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves help content to link to based on parameterNamespace and parameterName
org.apache.struts.action.ActionForward	getLookupHelpText(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves help for a lookup
org.apache.struts.action.ActionForward	getPageHelpText(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves help information from the data dictionary for the document type.
org.apache.struts.action.ActionForward	getResourceHelpText(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves help information from resources by key.
org.apache.struts.action.ActionForward	getStoredHelpUrl(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves help content to link to based on security group/parameter
protected void	populateHelpFormForResourceText(KualiHelpForm helpForm, String resourceKey) Utility method that populates a KualiHelpForm with the description from a given resource key

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

addMethodToCallToUncheckedList, checkAuthorization, defaultDispatch, dispatchMethod, doProcessingAfterPost, execute, findMethodToCall, getApplicationBaseUrl, getBusinessObjectAuthorizationService, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, 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

KualiHelpAction

public KualiHelpAction()

Method Detail

getAttributeHelpText

public org.apache.struts.action.ActionForward getAttributeHelpText(org.apache.struts.action.ActionMapping mapping,
                                                                   KualiHelpForm helpForm,
                                                                   javax.servlet.http.HttpServletRequest request,
                                                                   javax.servlet.http.HttpServletResponse response)
                                                            throws Exception

Retrieves help information from the data dictionary for the business object attribute.

Returns:

ActionForward

Throws:

Exception

getAttributeHelpText

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

Retrieves help information from the data dictionary for the business object attribute.

Returns:

ActionForward

Throws:

Exception

getDocumentHelpText

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

Retrieves help information from the data dictionary for the document type.

Throws:

Exception

getBusinessObjectHelpText

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

Retrieves help information from the data dictionary for the document type.

Throws:

Exception

getPageHelpText

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

Retrieves help information from the data dictionary for the document type.

Throws:

Exception

getStoredHelpUrl

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

Retrieves help content to link to based on security group/parameter

Throws:

Exception

getResourceHelpText

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

Retrieves help information from resources by key.

Throws:

Exception

populateHelpFormForResourceText

protected void populateHelpFormForResourceText(KualiHelpForm helpForm,
                                               String resourceKey)

Utility method that populates a KualiHelpForm with the description from a given resource key

Parameters:

helpForm - the KualiHelpForm to populate with help text

resourceKey - the resource key to use as help text

getLookupHelpText

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

Retrieves help for a lookup

Throws:

Exception

getDefaultLookupHelpResourceKey

protected String getDefaultLookupHelpResourceKey()

Returns:

the key of the default lookup help resource text

getHelpUrlByNamespace

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

Retrieves help content to link to based on parameterNamespace and parameterName

Throws:

Exception