net.dpml.state
Interface State

All Known Implementing Classes:
DefaultState, NullState

public interface State

Interface describing an application state.

Version:
1.2.0
Author:
Digital Product Meta Library

Field Summary
static State NULL_STATE
          Null state.
static String TYPE
          Constant artifact type for a state graph.
 
Method Summary
 Interface[] getInterfaces()
          Return the array of management interfaces associated with the state.
 String getName()
          Return the name of the state.
 Operation[] getOperations()
          Return the array of operations associated with the state.
 State getParent()
          Return the parent state to this state or null if this is the root of a state graph.
 State[] getStatePath()
          Return the state path.
 State[] getStates()
          Return the substates within this state.
 Transition[] getTransitions()
          Return the array of transtions associated with the state.
 Trigger[] getTriggers()
          Return the array of triggers associated with the state.
 boolean isTerminal()
          Test is the state is a terminal state.
 void setParent(State state)
          Set the parent state.
 

Field Detail

TYPE

static final String TYPE
Constant artifact type for a state graph.

See Also:
Constant Field Values

NULL_STATE

static final State NULL_STATE
Null state.

Method Detail

getName

String getName()
Return the name of the state.

Returns:
the state name

setParent

void setParent(State state)
Set the parent state.

Parameters:
state - the parent state

getParent

State getParent()
Return the parent state to this state or null if this is the root of a state graph.

Returns:
the parent state

getStatePath

State[] getStatePath()
Return the state path. The path is composed of a sequence of states from the root to this state.

Returns:
the state path

getStates

State[] getStates()
Return the substates within this state.

Returns:
the substate array

getTriggers

Trigger[] getTriggers()
Return the array of triggers associated with the state.

Returns:
the trigger array

getTransitions

Transition[] getTransitions()
Return the array of transtions associated with the state.

Returns:
the transition array

getOperations

Operation[] getOperations()
Return the array of operations associated with the state.

Returns:
the operation array

getInterfaces

Interface[] getInterfaces()
Return the array of management interfaces associated with the state.

Returns:
the interfaces array

isTerminal

boolean isTerminal()
Test is the state is a terminal state.

Returns:
true if terminal