Package org.kuali.rice.kew.actionlist

Class ActionListController

java.lang.Object
org.kuali.rice.krad.web.controller.UifControllerBase
org.kuali.rice.kew.actionlist.ActionListController
@Controller @RequestMapping("/kew/actionList") public class ActionListController extends org.kuali.rice.krad.web.controller.UifControllerBase
A controller for the action list view.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Constructor Summary

    Constructors
    Constructor
    Description
    ActionListController()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addCustomActions(List<? extends ActionItemBase> actionList, org.kuali.rice.kew.api.preferences.Preferences preferences, ActionListForm form)
    Adds custom actions to action items.
    org.springframework.web.servlet.ModelAndView
    cancelFilter(org.kuali.rice.krad.web.form.UifFormBase form)
    Revert to previous filter.
    org.springframework.web.servlet.ModelAndView
    clear(org.kuali.rice.krad.web.form.UifFormBase form)
    Clears the action list filter.
    org.springframework.web.servlet.ModelAndView
    clearFilter(org.kuali.rice.krad.web.form.UifFormBase form)
    Clears the action list filter.
    org.springframework.web.servlet.ModelAndView
    clearHelpDeskActionListUser(org.kuali.rice.krad.web.form.UifFormBase form)
    Clears help desk login.
    protected ActionListForm
    createInitialForm()
     
    protected ActionItemBase
    getActionItemFromActionList(List<? extends ActionItemBase> actionList, String actionItemId)
    Gets action item from list.
    protected int
    getPageSize(org.kuali.rice.kew.api.preferences.Preferences preferences)
    Get the action list page size.
    org.springframework.web.servlet.ModelAndView
    helpDeskActionListLogin(org.kuali.rice.krad.web.form.UifFormBase form)
    Sets up view for help desk login.
    protected void
    initializeDelegators(ActionListForm actionListForm, ActionListFilter filter, List<? extends ActionItemBase> actionList, javax.servlet.http.HttpServletRequest request)
    Initializes Delegators
    protected void
    initializeDocType(ActionListForm actionListForm, ActionListFilter filter)
    Initializes Document Type.
    protected void
    initializeFilter(ActionListForm form)
    Initializes filter.
    protected void
    initializePrimaryDelegate(ActionListForm actionListForm, ActionListFilter filter, List<? extends ActionItemBase> actionList, javax.servlet.http.HttpServletRequest request)
    Initializes primary delegate.
    protected String
    initializePrincipalId(ActionListForm actionListForm, ActionListFilter filter)
    Initializes principal id.
    org.springframework.web.servlet.ModelAndView
    refresh(org.kuali.rice.krad.web.form.UifFormBase form)
    Refresh request mapping.
    org.springframework.web.servlet.ModelAndView
    removeOutboxItems(org.kuali.rice.krad.web.form.UifFormBase form)
    Removes outbox items.
    protected void
    setDelegationId(ActionListForm actionListForm, javax.servlet.http.HttpServletRequest request)
    Sets the delegation id
    org.springframework.web.servlet.ModelAndView
    setFilter(org.kuali.rice.krad.web.form.UifFormBase form)
    Sets the filter.
    org.springframework.web.servlet.ModelAndView
    start(org.kuali.rice.krad.web.form.UifFormBase form)
    Start request mapping.
    protected org.springframework.web.servlet.ModelAndView
    takeMassActions(org.kuali.rice.krad.web.form.UifFormBase form)
    Process taking mass action on action items
    org.springframework.web.servlet.ModelAndView
    viewFilter(org.kuali.rice.krad.web.form.UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Navigates to filter view.
    org.springframework.web.servlet.ModelAndView
    viewPreferences(org.kuali.rice.krad.web.form.UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Navigate to preferences page.

    Methods inherited from class org.kuali.rice.krad.web.controller.UifControllerBase

    addBlankLine, addFileUploadLine, addLine, back, cancel, checkForm, closeEditLineDialog, defaultMapping, deleteFileUploadLine, deleteLine, editLine, getCollectionControllerService, getControllerService, getFileControllerService, getFileFromLine, getMessageView, getModelAndView, getModelAndView, getModelAndView, getModelAndViewService, getModelAndViewWithInit, getModelAndViewWithInit, getNavigationControllerService, getQueryControllerService, getRefreshControllerService, getSaveControllerService, initForm, navigate, performFieldQuery, performFieldSuggest, performLookup, performRedirect, performRedirect, retrieveCollectionPage, retrieveEditLineDialog, returnToHub, returnToPrevious, save, saveField, saveLine, sessionTimeout, setCollectionControllerService, setControllerService, setFileControllerService, setModelAndViewService, setNavigationControllerService, setQueryControllerService, setRefreshControllerService, setSaveControllerService, showDialog, tableJsonRetrieval

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ActionListController

      public ActionListController()

  • Method Details

    • createInitialForm

      protected ActionListForm createInitialForm()
      Specified by:
      createInitialForm in class org.kuali.rice.krad.web.controller.UifControllerBase

    • refresh

      @RequestMapping(params="methodToCall=refresh") public org.springframework.web.servlet.ModelAndView refresh(org.kuali.rice.krad.web.form.UifFormBase form)
      Refresh request mapping.

      Handles requests where the methodToCall parameter is 'refresh'.

      Overrides:
      refresh in class org.kuali.rice.krad.web.controller.UifControllerBase
      Parameters:
      form - - ActionListForm form
      result - - Spring form binding result
      request - - http request
      response - - http response
      Returns:
      start - forwards to start method

    • initializeFilter

      protected void initializeFilter(ActionListForm form)
      Initializes filter.

      Sets up the action list filter

      Parameters:
      form - - ActionListForm form

    • initializePrincipalId

      protected String initializePrincipalId(ActionListForm actionListForm, ActionListFilter filter)
      Initializes principal id.

      Sets up the principal id in the form.

      Parameters:
      actionListForm - - ActionListForm form
      filter - - action list filter
      Returns:
      String

    • initializeDocType

      protected void initializeDocType(ActionListForm actionListForm, ActionListFilter filter)
      Initializes Document Type.

      Sets up the document type in the form.

      Parameters:
      actionListForm - - ActionListForm form
      filter - - action list filter

    • initializeDelegators

      protected void initializeDelegators(ActionListForm actionListForm, ActionListFilter filter, List<? extends ActionItemBase> actionList, javax.servlet.http.HttpServletRequest request)
      Initializes Delegators

      Sets up the delegators for the form and filter

      Parameters:
      actionListForm - - ActionListForm form
      filter - - action list filter
      actionList - - list of action items
      request - - http request

    • setDelegationId

      protected void setDelegationId(ActionListForm actionListForm, javax.servlet.http.HttpServletRequest request)
      Sets the delegation id

      Sets the delegation id on the form

      Parameters:
      actionListForm - - ActionListForm form
      request - - http request

    • initializePrimaryDelegate

      protected void initializePrimaryDelegate(ActionListForm actionListForm, ActionListFilter filter, List<? extends ActionItemBase> actionList, javax.servlet.http.HttpServletRequest request)
      Initializes primary delegate.

      Sets up the primary delegate in the form.

      Parameters:
      actionListForm - - ActionListForm form
      filter - - action list filter
      actionList - - list of action items
      request - - http request

    • start

      @MethodAccessible @RequestMapping(params="methodToCall=start") public org.springframework.web.servlet.ModelAndView start(org.kuali.rice.krad.web.form.UifFormBase form)
      Start request mapping.

      Handles requests where the methodToCall parameter is 'start'. Runs on most requests and sets up the basic variables.

      Overrides:
      start in class org.kuali.rice.krad.web.controller.UifControllerBase
      Parameters:
      form - - ActionListForm form
      request - - http request
      response - - http response
      Returns:
      ModelAndView - uses standard KRAD getModelAndView()

    • getPageSize

      protected int getPageSize(org.kuali.rice.kew.api.preferences.Preferences preferences)
      Get the action list page size.

      Gets the page size of the Action List. Uses the user's preferences for page size unless the action list has been throttled by an application constant, in which case it uses the smaller of the two values.

      Parameters:
      preferences - KEW user preferences
      Returns:
      int

    • addCustomActions

      protected void addCustomActions(List<? extends ActionItemBase> actionList, org.kuali.rice.kew.api.preferences.Preferences preferences, ActionListForm form) throws org.kuali.rice.kew.api.exception.WorkflowException
      Adds custom actions to action items.

      Goes through each item in the action list and adds the custom actions. It also adds flags for whether each item has actions. Finally, creates list of actions and flag for the entire action list.

      Parameters:
      actionList - list of action items
      preferences - KEW preferences
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • takeMassActions

      @RequestMapping(params="methodToCall=takeMassActions") protected org.springframework.web.servlet.ModelAndView takeMassActions(org.kuali.rice.krad.web.form.UifFormBase form)
      Process taking mass action on action items

      Handles requests where the methodToCall parameter is 'takeMassActions'. Iterates through action items that have custom actions and process each selected action.

      Parameters:
      form - - ActionListForm form
      result - - Spring form binding result
      request - - http request
      response - - http response
      Returns:
      start - forwards to the start method

    • getActionItemFromActionList

      protected ActionItemBase getActionItemFromActionList(List<? extends ActionItemBase> actionList, String actionItemId)
      Gets action item from list.

      Gets the action item from the action item list based on the ID.

      Parameters:
      actionList - - list of action items
      actionItemId - - primary key for action item
      Returns:
      ActionItem or null

    • helpDeskActionListLogin

      @MethodAccessible @RequestMapping(params="methodToCall=helpDeskActionListLogin") public org.springframework.web.servlet.ModelAndView helpDeskActionListLogin(org.kuali.rice.krad.web.form.UifFormBase form)
      Sets up view for help desk login.

      Setups the view for the help desk login. User can see other's action items but can't take action on them.

      Parameters:
      form - - ActionListForm form
      result - - Spring form binding result
      request - - http request
      response - - http response
      Returns:
      start() - forwards to start method to refresh action list

    • clearFilter

      @RequestMapping(params="methodToCall=clearFilter") public org.springframework.web.servlet.ModelAndView clearFilter(org.kuali.rice.krad.web.form.UifFormBase form)
      Clears the action list filter.

      Clears the action list filter so all action items are shown.

      Parameters:
      form - - ActionListForm form
      result - - Spring form binding result
      request - - http request
      response - - http response
      Returns:
      start() - forwards to start to refresh action list

    • clear

      @RequestMapping(params="methodToCall=clear") public org.springframework.web.servlet.ModelAndView clear(org.kuali.rice.krad.web.form.UifFormBase form)
      Clears the action list filter.

      Clears the action list filter so all action items are shown. Clears filter from secondary page and then forwards to the correct page after the start method runs.

      Parameters:
      form - ActionListForm form
      Returns:
      clearFilter() - forwards to clearFilter method

    • setFilter

      @RequestMapping(params="methodToCall=setFilter") public org.springframework.web.servlet.ModelAndView setFilter(org.kuali.rice.krad.web.form.UifFormBase form)
      Sets the filter.

      Sets the action list filter in the form.

      Parameters:
      form - - ActionListForm form
      result - - Spring form binding result
      request - - http request
      response - - http response
      Returns:
      start() forwards to start method to refresh action list

    • clearHelpDeskActionListUser

      @RequestMapping(params="methodToCall=clearHelpDeskActionListUser") public org.springframework.web.servlet.ModelAndView clearHelpDeskActionListUser(org.kuali.rice.krad.web.form.UifFormBase form)
      Clears help desk login.

      Set the form back to display the logged in user's action list.

      Parameters:
      form - - ActionListForm form
      Returns:
      start() - forwards to start method to refresh the action list

    • removeOutboxItems

      @RequestMapping(params="methodToCall=removeOutboxItems") public org.springframework.web.servlet.ModelAndView removeOutboxItems(org.kuali.rice.krad.web.form.UifFormBase form)
      Removes outbox items.

      Removes any outbox items that are selected.

      Parameters:
      form - - ActionListForm form
      Returns:
      start() forwards to start to refresh the outbox.

    • viewFilter

      @RequestMapping(params="methodToCall=viewFilter") public org.springframework.web.servlet.ModelAndView viewFilter(@ModelAttribute("KualiForm") org.kuali.rice.krad.web.form.UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Navigates to filter view.

      Navigate to the Action List Filter page, preserving any newly-modified primary/secondary delegation filters as necessary.

      Parameters:
      form - - ActionListForm form
      result - - Spring form binding result
      request - - http request
      response - - http response
      Returns:
      ModelAndView - forwards to the standard KRAD getModelAndView method

    • cancelFilter

      @RequestMapping(params="methodToCall=cancelFilter") public org.springframework.web.servlet.ModelAndView cancelFilter(org.kuali.rice.krad.web.form.UifFormBase form)
      Revert to previous filter.

      When user changes the filter but presses cancel, the filter goes back to the old filter.

      Parameters:
      form - - ActionListForm form
      Returns:
      start() forwards to start method to refresh teh action list

    • viewPreferences

      @RequestMapping(params="methodToCall=viewPreferences") public org.springframework.web.servlet.ModelAndView viewPreferences(@ModelAttribute("KualiForm") org.kuali.rice.krad.web.form.UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Navigate to preferences page.

      Navigate to the user's Preferences page, preserving any newly-modified primary/secondary delegation filters as necessary.

      Parameters:
      form - - ActionListForm form
      result - - Spring form binding result
      request - - http request
      response - - http response
      Returns:
      ModelAndView - forwards to KRAD standard getModelAndView method