Package org.kuali.rice.kew.actionlist

Interface CustomActionListAttribute

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultCustomActionListAttribute, NotificationCustomActionListAttribute

public interface CustomActionListAttribute
extends Serializable

An attribute which allows for the Action List to be customized to provide Mass Actions and an internal frame for displaying a summary view of the document on each row in the Action List.

Author:

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

See Also:

• ActionListAction
• DefaultCustomActionListAttribute

Method Summary

Modifier and Type	Method	Description
org.kuali.rice.kew.api.actionlist.DisplayParameters	getDocHandlerDisplayParameters(String principalId, org.kuali.rice.kew.api.action.ActionItem actionItem)	Returns the display parameters for the inline framed doc handler on the Action List.
org.kuali.rice.kew.api.action.ActionSet	getLegalActions(String principalId, org.kuali.rice.kew.api.action.ActionItem actionItem)	Returns the set of legal actions for this Action List attribute.

Method Details

getLegalActions

org.kuali.rice.kew.api.action.ActionSet getLegalActions(String principalId,
 org.kuali.rice.kew.api.action.ActionItem actionItem)
                                                 throws Exception

Returns the set of legal actions for this Action List attribute. This set of actions dictates which actions can be taken on the document from the ActionList. If this method returns null then action invocation will not be available from the action list.

Throws:

Exception

getDocHandlerDisplayParameters

org.kuali.rice.kew.api.actionlist.DisplayParameters getDocHandlerDisplayParameters(String principalId,
 org.kuali.rice.kew.api.action.ActionItem actionItem)
                                                                            throws Exception

Returns the display parameters for the inline framed doc handler on the Action List. If this method returns null, then a default value will be used.

Throws:

Exception