oracle.cle.util.statemachine
Interface State

All Known Implementing Classes:

Process

public interface State

A State in a StateMachine. This should be able to be started by a machine, determine if it has been designated as an end state (for speed optimization purposes) and return a transition condition.

See Also:

StateMachine

Method Summary

void	addCondition(TransitionCondition aTransitionCondition) Add a TransitionCondition to the set of possible conditions for this state.
TransitionCondition	generateFailureCondition() Returns a TransitionCondition with a negative int
TransitionCondition	generateSuccessCondition() Returns a TransitionCondition with a positive int or zero
TransitionCondition	getCondition(java.lang.String key) Returns a TransitionCondition for the specified key
java.util.Vector	getConditions() Returns a Vector of the TransitionConditions available for this State
java.lang.String	getName() Return the name of the state
boolean	isEndState() Returns true if this is an end State...
void	removeCondition(TransitionCondition aTransitionCondition) Remove a TransitionCondition from the set of possible conditions for this state.
TransitionCondition	returnCondition() Returns the transition condition for this State
void	setCondition(java.lang.String aCondition) Sets the condition attribute.
void	setCondition(TransitionCondition aCondition) Sets the condition attribute to the parameter passed in
void	start() Starts this State

Method Detail

start

public void start()
           throws TransitionConditionException

Starts this State

isEndState

public boolean isEndState()

Returns true if this is an end State... false otherwise

returnCondition

public TransitionCondition returnCondition()

Returns the transition condition for this State

addCondition

public void addCondition(TransitionCondition aTransitionCondition)

Add a TransitionCondition to the set of possible conditions for this state.

See Also:

StateMachine

removeCondition

public void removeCondition(TransitionCondition aTransitionCondition)

Remove a TransitionCondition from the set of possible conditions for this state. Typically, this method is used bt the TransitionTable when the StateMachine's transitiontable is being edited. You should never need to call this.

See Also:

StateMachine

getConditions

public java.util.Vector getConditions()

Returns a Vector of the TransitionConditions available for this State

getCondition

public TransitionCondition getCondition(java.lang.String key)

Returns a TransitionCondition for the specified key

setCondition

public void setCondition(java.lang.String aCondition)
                  throws TransitionConditionException

Sets the condition attribute. getCondition(String a String will be called to get a TransitionCondition and then the value will be used for the attribute condition

See Also:

getCondition(String)

setCondition

public void setCondition(TransitionCondition aCondition)
                  throws TransitionConditionException

Sets the condition attribute to the parameter passed in

generateSuccessCondition

public TransitionCondition generateSuccessCondition()

Returns a TransitionCondition with a positive int or zero

generateFailureCondition

public TransitionCondition generateFailureCondition()

Returns a TransitionCondition with a negative int

getName

public java.lang.String getName()

Return the name of the state