Package org.kuali.rice.kew.preferences.web

Class PreferencesForm

java.lang.Object
org.apache.struts.action.ActionForm
org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase
org.kuali.rice.kns.web.struts.form.KualiForm
org.kuali.rice.kew.preferences.web.PreferencesForm
All Implemented Interfaces:
Serializable, org.kuali.rice.kns.web.struts.form.pojo.PojoForm
public class PreferencesForm extends org.kuali.rice.kns.web.struts.form.KualiForm
Struts ActionForm for PreferencesAction.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

    org.kuali.rice.kns.web.struts.form.KualiForm.TabState

  • Field Summary

    Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

    extraButtons

    Fields inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

    requiredNonEditableProperties

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

    multipartRequestHandler, servlet

  • Constructor Summary

    Constructors
    Constructor
    Description
    PreferencesForm()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBackLocation()
     
    Object
    getDocumentTypeNotificationPreference(String documentType)
     
    String
    getDocumentTypePreferenceName()
     
    String
    getDocumentTypePreferenceValue()
     
    String
    getMethodToCall()
     
    org.kuali.rice.kew.api.preferences.Preferences.Builder
    getPreferences()
     
    String
    getReturnMapping()
     
    boolean
    isShowOutbox()
     
    void
    populate(javax.servlet.http.HttpServletRequest request)
    Retrieves the "returnLocation" parameter after calling "populate" on the superclass.
    void
    setBackLocation(String backLocation)
     
    void
    setDocumentTypeNotificationPreference(String documentType, String preferenceValue)
     
    void
    setDocumentTypePreferenceName(String documentTypePreferenceName)
     
    void
    setDocumentTypePreferenceValue(String documentTypePreferenceValue)
     
    void
    setMethodToCall(String methodToCall)
     
    void
    setPreferences(org.kuali.rice.kew.api.preferences.Preferences.Builder preferences)
     
    void
    setReturnMapping(String returnMapping)
     
    void
    setShowOutbox(boolean showOutbox)
     
    void
    validatePreferences()
     

    Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

    addRequiredNonEditableProperties, clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getExtraButtons, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populateBackLocation, populateFieldLevelHelpEnabled, reset, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setCurrentTabIndex, setDerivedValuesOnForm, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates, shouldMethodToCallParameterBeUsed, shouldPropertyBePopulatedInForm

    Methods inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

    addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, customInitMaxUploadSizes, formatterClassForKeypath, formatValue, getActionEditablePropertiesGuid, getEditableProperties, getFormatter, getFormatterTypes, getIsNewForm, getMaxUploadSizes, getMethodToCallsToBypassSessionRetrievalForGETRequests, getParameter, getParameterValues, getPopulateEditableProperties, getPopulateEditablePropertiesGuid, getPropertyType, getRequiredNonEditableProperties, getStrutsActionMappingScope, getUnconvertedValues, getUnknownKeys, initMaxUploadSizes, isPropertyEditable, isPropertyNonEditableButRequired, populateForProperty, postprocessRequestParameters, processValidationFail, registerEditableProperty, registerIsNewForm, registerRequiredNonEditableProperty, registerStrutsActionMappingScope, setActionEditablePropertiesGuid, setFormatterType, setFormatterTypes, setPopulateEditablePropertiesGuid, setUnconvertedValues

    Methods inherited from class org.apache.struts.action.ActionForm

    getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate, validate

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PreferencesForm

      public PreferencesForm()

  • Method Details

    • getReturnMapping

      public String getReturnMapping()

    • setReturnMapping

      public void setReturnMapping(String returnMapping)

    • getMethodToCall

      public String getMethodToCall()
      Overrides:
      getMethodToCall in class org.kuali.rice.kns.web.struts.form.KualiForm

    • setMethodToCall

      public void setMethodToCall(String methodToCall)
      Overrides:
      setMethodToCall in class org.kuali.rice.kns.web.struts.form.KualiForm

    • getPreferences

      public org.kuali.rice.kew.api.preferences.Preferences.Builder getPreferences()

    • setPreferences

      public void setPreferences(org.kuali.rice.kew.api.preferences.Preferences.Builder preferences)

    • isShowOutbox

      public boolean isShowOutbox()

    • setShowOutbox

      public void setShowOutbox(boolean showOutbox)

    • getBackLocation

      public String getBackLocation()
      Overrides:
      getBackLocation in class org.kuali.rice.kns.web.struts.form.KualiForm

    • setBackLocation

      public void setBackLocation(String backLocation)
      Overrides:
      setBackLocation in class org.kuali.rice.kns.web.struts.form.KualiForm

    • getDocumentTypePreferenceName

      public String getDocumentTypePreferenceName()

    • setDocumentTypePreferenceName

      public void setDocumentTypePreferenceName(String documentTypePreferenceName)

    • getDocumentTypePreferenceValue

      public String getDocumentTypePreferenceValue()

    • setDocumentTypePreferenceValue

      public void setDocumentTypePreferenceValue(String documentTypePreferenceValue)

    • getDocumentTypeNotificationPreference

      public Object getDocumentTypeNotificationPreference(String documentType)

    • setDocumentTypeNotificationPreference

      public void setDocumentTypeNotificationPreference(String documentType, String preferenceValue)

    • populate

      public void populate(javax.servlet.http.HttpServletRequest request)
      Retrieves the "returnLocation" parameter after calling "populate" on the superclass.
      Specified by:
      populate in interface org.kuali.rice.kns.web.struts.form.pojo.PojoForm
      Overrides:
      populate in class org.kuali.rice.kns.web.struts.form.KualiForm
      See Also:
      • invalid reference 
        org.kuali.rice.krad.web.struts.form.KualiForm#populate(javax.servlet.http.HttpServletRequest)

    • validatePreferences

      public void validatePreferences()