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(value="/new/actionList")
public class ActionListController
extends UifControllerBase

A controller for the action list view.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	MAX_ACTION_ITEM_DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
ActionListController()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCustomActions(List<? extends ActionItemActionListExtension> actionList, Preferences preferences, ActionListForm form) Adds custom actions to action items.
org.springframework.web.servlet.ModelAndView	cancelFilter(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Revert to previous filter.
org.springframework.web.servlet.ModelAndView	clear(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clears the action list filter.
org.springframework.web.servlet.ModelAndView	clearFilter(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clears the action list filter.
org.springframework.web.servlet.ModelAndView	clearHelpDeskActionListUser(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clears help desk login.
protected ActionListForm	createInitialForm(javax.servlet.http.HttpServletRequest request) Called to create a new model(form) object when necessary.
protected ActionItemActionListExtension	getActionItemFromActionList(List<? extends ActionItemActionListExtension> actionList, String actionItemId) Gets action item from list.
protected int	getPageSize(Preferences preferences) Get the action list page size.
org.springframework.web.servlet.ModelAndView	helpDeskActionListLogin(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Sets up view for help desk login.
protected void	initializeDelegators(ActionListForm actionListForm, ActionListFilter filter, List<? extends ActionItemActionListExtension> 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 ActionItemActionListExtension> actionList, javax.servlet.http.HttpServletRequest request) Initializes primary delegate.
protected String	initializePrinicpalId(ActionListForm actionListForm, ActionListFilter filter) Initializes principal id.
org.springframework.web.servlet.ModelAndView	refresh(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Refresh request mapping.
org.springframework.web.servlet.ModelAndView	removeOutboxItems(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Removes outbox items.
protected void	setDelegationId(ActionListForm actionListForm, javax.servlet.http.HttpServletRequest request) Sets the delegation id
org.springframework.web.servlet.ModelAndView	setFilter(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Sets the filter.
org.springframework.web.servlet.ModelAndView	start(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Start request mapping.
protected org.springframework.web.servlet.ModelAndView	takeMassActions(UifFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Process taking mass action on action items
org.springframework.web.servlet.ModelAndView	viewFilter(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(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, addLine, back, cancel, checkForm, checkViewAuthorization, createDataTablesPagingHelperInstance, defaultMapping, deleteLine, getBooleanDialogResponse, getMessageView, getStringDialogResponse, getUIFModelAndView, getUIFModelAndView, getUIFModelAndView, getUIFModelAndViewWithInit, getViewService, hasDialogBeenAnswered, hasDialogBeenDisplayed, initForm, navigate, performFieldQuery, performFieldSuggest, performLookup, performRedirect, performRedirect, resetDialogStatus, retrieveCollectionPage, retrieveOriginalComponent, returnFromLightbox, returnToHistory, returnToHub, returnToPrevious, saveLine, sessionTimeout, showDialog, tableCsvRetrieval, tableJsonRetrieval, tableXlsRetrieval, tableXmlRetrieval

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ACTION_ITEM_DATE_FORMAT

protected static final String MAX_ACTION_ITEM_DATE_FORMAT

See Also:

Constant Field Values

Constructor Detail

ActionListController

public ActionListController()

Method Detail

createInitialForm

protected ActionListForm createInitialForm(javax.servlet.http.HttpServletRequest request)

Description copied from class: UifControllerBase

Called to create a new model(form) object when necessary. This usually occurs on the initial request in a conversation (when the model is not present in the session). This method must be overridden when extending a controller and using a different form type than the superclass.

Specified by:

createInitialForm in class UifControllerBase

Parameters:

request - - the http request that was made

refresh

@RequestMapping(params="methodToCall=refresh")
public org.springframework.web.servlet.ModelAndView refresh(@ModelAttribute(value="KualiForm")
                                                                  UifFormBase form,
                                                                  org.springframework.validation.BindingResult result,
                                                                  javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response)

Refresh request mapping.

Handles requests where the methodToCall parameter is 'refresh'.

Overrides:

refresh in class 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

initializePrinicpalId

protected String initializePrinicpalId(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 ActionItemActionListExtension> 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 ActionItemActionListExtension> 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

@RequestMapping(params="methodToCall=start")
public org.springframework.web.servlet.ModelAndView start(@ModelAttribute(value="KualiForm")
                                                                UifFormBase form,
                                                                org.springframework.validation.BindingResult result,
                                                                javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response)

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 UifControllerBase

Parameters:

form - - ActionListForm form

result - - Spring form binding result

request - - http request

response - - http response

Returns:

ModelAndView - uses standard KRAD getUIFModelAndView()

getPageSize

protected int getPageSize(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 ActionItemActionListExtension> actionList,
                    Preferences preferences,
                    ActionListForm form)
                         throws 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:

WorkflowException

takeMassActions

@RequestMapping(params="methodToCall=takeMassActions")
protected org.springframework.web.servlet.ModelAndView takeMassActions(@ModelAttribute(value="KualiForm")
                                                                          UifFormBase form,
                                                                          org.springframework.validation.BindingResult result,
                                                                          javax.servlet.http.HttpServletRequest request,
                                                                          javax.servlet.http.HttpServletResponse response)

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 ActionItemActionListExtension getActionItemFromActionList(List<? extends ActionItemActionListExtension> 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:

ActionItemActionListExtension or null

helpDeskActionListLogin

@RequestMapping(params="methodToCall=helpDeskActionListLogin")
public org.springframework.web.servlet.ModelAndView helpDeskActionListLogin(@ModelAttribute(value="KualiForm")
                                                                                  UifFormBase form,
                                                                                  org.springframework.validation.BindingResult result,
                                                                                  javax.servlet.http.HttpServletRequest request,
                                                                                  javax.servlet.http.HttpServletResponse response)

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(@ModelAttribute(value="KualiForm")
                                                                      UifFormBase form,
                                                                      org.springframework.validation.BindingResult result,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response)

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(@ModelAttribute(value="KualiForm")
                                                                UifFormBase form,
                                                                org.springframework.validation.BindingResult result,
                                                                javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response)

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

result - - Spring form binding result

request - - http request

response - - http response

Returns:

clearFilter() - forwards to clearFilter method

setFilter

@RequestMapping(params="methodToCall=setFilter")
public org.springframework.web.servlet.ModelAndView setFilter(@ModelAttribute(value="KualiForm")
                                                                    UifFormBase form,
                                                                    org.springframework.validation.BindingResult result,
                                                                    javax.servlet.http.HttpServletRequest request,
                                                                    javax.servlet.http.HttpServletResponse response)

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(@ModelAttribute(value="KualiForm")
                                                                                      UifFormBase form,
                                                                                      org.springframework.validation.BindingResult result,
                                                                                      javax.servlet.http.HttpServletRequest request,
                                                                                      javax.servlet.http.HttpServletResponse response)

Clears help desk login.

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

Parameters:

form - - ActionListForm form

result - - Spring form binding result

request - - http request

response - - http response

Returns:

start() - forwards to start method to refresh the action list

removeOutboxItems

@RequestMapping(params="methodToCall=removeOutboxItems")
public org.springframework.web.servlet.ModelAndView removeOutboxItems(@ModelAttribute(value="KualiForm")
                                                                            UifFormBase form,
                                                                            org.springframework.validation.BindingResult result,
                                                                            javax.servlet.http.HttpServletRequest request,
                                                                            javax.servlet.http.HttpServletResponse response)

Removes outbox items.

Removes any outbox items that are selected.

Parameters:

form - - ActionListForm form

result - - Spring form binding result

request - - http request

response - - http response

Returns:

start() forwards to start to refresh the outbox.

viewFilter

@RequestMapping(params="methodToCall=viewFilter")
public org.springframework.web.servlet.ModelAndView viewFilter(@ModelAttribute(value="KualiForm")
                                                                     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 getUIFModelAndView method

cancelFilter

@RequestMapping(params="methodToCall=cancelFilter")
public org.springframework.web.servlet.ModelAndView cancelFilter(@ModelAttribute(value="KualiForm")
                                                                       UifFormBase form,
                                                                       org.springframework.validation.BindingResult result,
                                                                       javax.servlet.http.HttpServletRequest request,
                                                                       javax.servlet.http.HttpServletResponse response)

Revert to previous filter.

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

Parameters:

form - - ActionListForm form

result - - Spring form binding result

request - - http request

response - - http response

Returns:

start() forwards to start method to refresh teh action list

viewPreferences

@RequestMapping(params="methodToCall=viewPreferences")
public org.springframework.web.servlet.ModelAndView viewPreferences(@ModelAttribute(value="KualiForm")
                                                                          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 getUIFModelAndView method