org.kuali.rice.kew.preferences.web
Class PreferencesAction

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.kew.web.KewKualiAction
                      org.kuali.rice.kew.preferences.web.PreferencesAction

public class PreferencesAction
extends KewKualiAction

A Struts Action for interfaces with Preferences.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

PreferencesService, Preferences

Field Summary

static String

SAVE_REMINDER_ATTR

Fields inherited from class org.kuali.rice.kew.web.KewKualiAction

DEFAULT_MAPPING

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

PreferencesAction()

Method Summary

org.apache.struts.action.ActionForward	addNotificationPreference(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	deleteNotificationPreference(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	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.
void	getDelegatorFilterChoices(javax.servlet.http.HttpServletRequest request)
PreferencesService	getPreferencesService()
void	getPrimaryDelegateFilterChoices(javax.servlet.http.HttpServletRequest request)
org.apache.struts.action.ActionMessages	initForm(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForm form)
org.apache.struts.action.ActionForward	registerDocumentTypePreference(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	save(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setPreferencesService(PreferencesService preferencesService)
org.apache.struts.action.ActionForward	start(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class org.kuali.rice.kew.web.KewKualiAction

defaultDispatch, getDefaultMapping, getReturnLocation

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

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

Field Detail

SAVE_REMINDER_ATTR

public static final String SAVE_REMINDER_ATTR

See Also:

Constant Field Values

Constructor Detail

PreferencesAction

public PreferencesAction()

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

Description copied from class: KualiAction

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:

execute in class KualiAction

Throws:

Exception

See Also:

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

start

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

Overrides:

start in class KewKualiAction

Throws:

Exception

save

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

Throws:

Exception

initForm

public org.apache.struts.action.ActionMessages initForm(javax.servlet.http.HttpServletRequest request,
                                                        org.apache.struts.action.ActionForm form)
                                                 throws Exception

Throws:

Exception

getDelegatorFilterChoices

public void getDelegatorFilterChoices(javax.servlet.http.HttpServletRequest request)

getPrimaryDelegateFilterChoices

public void getPrimaryDelegateFilterChoices(javax.servlet.http.HttpServletRequest request)

addNotificationPreference

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

deleteNotificationPreference

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

registerDocumentTypePreference

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

Throws:

Exception

getPreferencesService

public PreferencesService getPreferencesService()

Returns:

the preferencesService

setPreferencesService

public void setPreferencesService(PreferencesService preferencesService)

Parameters:

preferencesService - the preferencesService to set