com.silverpeas.workflow.api.model
Interface States

All Known Implementing Classes:

StatesImpl

public interface States

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

Method Summary

void	addState(State state) Add an state to the collection
State	createState() Create an State
State	getState(String name) Get the state definition with given name
State[]	getStates() Get the states defined for this process model
Iterator<State>	iterateState() Iterate through the State objects
void	removeState(String strStateName) Remove an state from the collection

Method Detail

iterateState

Iterator<State> iterateState()

Iterate through the State objects

Returns:

an iterator

createState

State createState()

Create an State

Returns:

an object implementing State

addState

void addState(State state)

Add an state to the collection

Parameters:

state - to be added

getStates

State[] getStates()

Get the states defined for this process model

Returns:

states defined for this process model

getState

State getState(String name)

Get the state definition with given name

Parameters:

name - state name

Returns:

wanted state definition

removeState

void removeState(String strStateName)
                 throws WorkflowException

Remove an state from the collection

Parameters:

strStateName - the name of the state to be removed.

Throws:

WorkflowException - when the state cannot be found