Package org.kuali.rice.kew.actions

Class ActionRegistryImpl

java.lang.Object

org.kuali.rice.kew.actions.ActionRegistryImpl

All Implemented Interfaces:

ActionRegistry

public class ActionRegistryImpl
extends Object
implements ActionRegistry

A simple implementation of an ActionRegistry which includes all of the default Workflow Actions.

Author:

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

Constructor Summary

Constructors

Constructor	Description
ActionRegistryImpl()

Method Summary

Modifier and Type	Method	Description
ActionTakenEvent	createAction(String actionCode, List<org.kuali.rice.core.api.reflect.DataDefinition> parameters)	Constructs and returns the ActionTakenEvent implementation which can be used to invoke the Action with the given parameters.
Map	getActionMap()	Returns an immutable map of the Action Code to Action Class mappings in this registry.
org.kuali.rice.kew.api.action.ValidActions	getValidActions(org.kuali.rice.kim.api.identity.principal.PrincipalContract principal, DocumentRouteHeaderValue document)	Returns a List of valid action codes for the given user on the document.
boolean	isValidAction(String actionTypeCode, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal, DocumentRouteHeaderValue document)	Determines whether the given action type is valid for the given user and document instance.
void	registerAction(String actionCode, String actionClass)	Registers the given Action.
void	unregisterAction(String actionCode)	Unregisters the Action with the given code.

Methods inherited from class java.lang.Object

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

Constructor Details

ActionRegistryImpl

public ActionRegistryImpl()

Method Details

registerAction

public void registerAction(String actionCode,
 String actionClass)

Description copied from interface: ActionRegistry

Registers the given Action.

Specified by:

registerAction in interface ActionRegistry

Parameters:

actionCode - Should be a one-letter unique code

actionClass - the fully-qualified Java classname of the ActionTakenEvent implementation

unregisterAction

public void unregisterAction(String actionCode)

Description copied from interface: ActionRegistry

Unregisters the Action with the given code.

Specified by:

unregisterAction in interface ActionRegistry

getActionMap

public Map getActionMap()

Description copied from interface: ActionRegistry

Returns an immutable map of the Action Code to Action Class mappings in this registry.

Specified by:

getActionMap in interface ActionRegistry

createAction

public ActionTakenEvent createAction(String actionCode,
 List<org.kuali.rice.core.api.reflect.DataDefinition> parameters)
                              throws org.kuali.rice.kew.api.exception.ResourceUnavailableException

Description copied from interface: ActionRegistry

Constructs and returns the ActionTakenEvent implementation which can be used to invoke the Action with the given parameters.

Specified by:

createAction in interface ActionRegistry

Throws:

org.kuali.rice.kew.api.exception.ResourceUnavailableException - if the action class cannot be constructed

getValidActions

public org.kuali.rice.kew.api.action.ValidActions getValidActions(org.kuali.rice.kim.api.identity.principal.PrincipalContract principal,
 DocumentRouteHeaderValue document)

Description copied from interface: ActionRegistry

Returns a List of valid action codes for the given user on the document.

Specified by:

getValidActions in interface ActionRegistry

isValidAction

public boolean isValidAction(String actionTypeCode,
 org.kuali.rice.kim.api.identity.principal.PrincipalContract principal,
 DocumentRouteHeaderValue document)

Description copied from interface: ActionRegistry

Determines whether the given action type is valid for the given user and document instance.

Specified by:

isValidAction in interface ActionRegistry