Package org.kuali.rice.kew.actionlist

Class DefaultCustomActionListAttribute

java.lang.Object

org.kuali.rice.kew.actionlist.DefaultCustomActionListAttribute

All Implemented Interfaces:

Serializable, CustomActionListAttribute

public class DefaultCustomActionListAttribute
extends Object
implements CustomActionListAttribute

The default implementation of a CustomActionListAttribute. Shows only FYI actions.

Author:

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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultCustomActionListAttribute()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultCustomActionListAttribute

public DefaultCustomActionListAttribute()

Method Details

getLegalActions

public ActionSet getLegalActions(String principalId,
 ActionItem actionItem)
                          throws Exception

Description copied from interface: CustomActionListAttribute

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.

Specified by:

getLegalActions in interface CustomActionListAttribute

Throws:

Exception

getDocHandlerDisplayParameters

public DisplayParameters getDocHandlerDisplayParameters(String principalId,
 ActionItem actionItem)
                                                 throws Exception

Description copied from interface: CustomActionListAttribute

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.

Specified by:

getDocHandlerDisplayParameters in interface CustomActionListAttribute

Throws:

Exception