org.apache.lenya.workflow
Interface Workflow

public interface Workflow

A workflow schema.

A workflow schema defines a state machine (deterministic finite automaton - DFA), consisting of

• states, including a marked initial state,
• transitions, and
• state variables.

Field Summary

static java.lang.String	DEFAULT_PREFIX DEFAULT_PREFIX Default workflow namespace prefix
static java.lang.String	NAMESPACE NAMESPACE Workflow namespace URI

Method Summary

java.lang.String[]	getEvents()
java.lang.String	getInitialState() Returns the initial state of this workflow.
boolean	getInitialValue(java.lang.String variableName)
Transition[]	getLeavingTransitions(java.lang.String state) Returns the transitions that leave a state.
java.lang.String	getName()
java.lang.String[]	getStates()
java.lang.String[]	getVariableNames() Returns the variable names.

Field Detail

NAMESPACE

static final java.lang.String NAMESPACE

NAMESPACE Workflow namespace URI

See Also:

Constant Field Values

DEFAULT_PREFIX

static final java.lang.String DEFAULT_PREFIX

DEFAULT_PREFIX Default workflow namespace prefix

See Also:

Constant Field Values

Method Detail

getInitialState

java.lang.String getInitialState()

Returns the initial state of this workflow.

Returns:

The initial state

getLeavingTransitions

Transition[] getLeavingTransitions(java.lang.String state)
                                   throws WorkflowException

Returns the transitions that leave a state. This method is used, e.g., to disable menu items.

Parameters:

state - A state.

Returns:

The transitions that leave the state.

Throws:

WorkflowException - if the state is not contained.

getVariableNames

java.lang.String[] getVariableNames()

Returns the variable names.

Returns:

A string array.

getName

java.lang.String getName()

Returns:

The name of this workflow.

getInitialValue

boolean getInitialValue(java.lang.String variableName)
                        throws WorkflowException

Parameters:

variableName - The variable name.

Returns:

The initial value of the variable.

Throws:

WorkflowException - if the variable does not exist.

getEvents

java.lang.String[] getEvents()

Returns:

The events.

getStates

java.lang.String[] getStates()

Returns:

The states.