org.kuali.rice.ken.kew

Class NotificationCustomActionListAttribute

java.lang.Object

org.kuali.rice.ken.kew.NotificationCustomActionListAttribute

All Implemented Interfaces:

Serializable, CustomActionListAttribute

public class NotificationCustomActionListAttribute
extends Object
implements CustomActionListAttribute

This class is our custom action list for Notifications in KEW. It's wired in as the implementation to use as part of the NotificationData.xml bootstrap file for KEW.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotificationCustomActionListAttribute()

Method Summary

Modifier and Type	Method and 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 Detail

NotificationCustomActionListAttribute

public NotificationCustomActionListAttribute()

Method Detail

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

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