com.silverpeas.workflow.api.model
Interface AllowedActions

All Known Implementing Classes:

ActionRefs

public interface AllowedActions

Interface describing a representation of the <allowedActions> element of a Process Model.

Method Summary

void	addAllowedAction(AllowedAction allowedAction) Add an allowedAction to the collection
AllowedAction	createAllowedAction() Create an AllowedAction
AllowedAction	getAllowedAction(String strActionName) Get allowed action by action name
Action[]	getAllowedActions() Get available actions
Iterator<AllowedAction>	iterateAllowedAction() Iterate through the AllowedAction objects
void	removeAllowedAction(String strAllowedActionName) Remove an allowedAction from the collection

Method Detail

iterateAllowedAction

Iterator<AllowedAction> iterateAllowedAction()

Iterate through the AllowedAction objects

Returns:

an iterator

createAllowedAction

AllowedAction createAllowedAction()

Create an AllowedAction

Returns:

an object implementing AllowedAction

addAllowedAction

void addAllowedAction(AllowedAction allowedAction)

Add an allowedAction to the collection

Parameters:

allowedAction - to be added

getAllowedActions

Action[] getAllowedActions()

Get available actions

Returns:

allowed actions in an array

getAllowedAction

AllowedAction getAllowedAction(String strActionName)

Get allowed action by action name

Parameters:

strActionName - the name of the action to find

Returns:

allowed action or null if action not found

removeAllowedAction

void removeAllowedAction(String strAllowedActionName)
                         throws WorkflowException

Remove an allowedAction from the collection

Parameters:

strAllowedActionName - the name of the allowedAction to be removed.

Throws:

WorkflowException