|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The CpStateMachine interface represents a state machine for a conversation policy.
Note that neither the "current role" nor the "current state" of the policy is stored here. The CpStateMachine thus describes only the state-transition structure of the conversation policy, which does not change during its execution. This permits a single CpStateMachine instance to be shared among several ConversationPolicyHandlers.
CpStateMachineHandler
Method Summary | |
---|---|
void |
addRole(java.lang.String newRole)
Adds the given role to the set of roles supported by the policy. |
void |
addState(CpState newState)
Adds the given state to the policy state machine. |
void |
clear()
Removes all roles, states, and transitions that have been added to this state machine. |
CpState |
getInitialState()
Returns the initial state of the policy. |
java.lang.String |
getInitialStateName()
Returns the name of the policy's initial state. |
int |
getNumStates()
Returns the number of states in the policy state machine. |
java.lang.String |
getPolicyName()
Returns the name of the policy. |
java.util.Collection |
getRoles()
Returns a Collection containing the roles supported by the policy. |
CpState |
getState(java.lang.String name)
Returns the state with the given name |
java.util.Collection |
getStates()
Returns a Collection containing all the states in the poliy state machine. |
CpStateTransition |
getTransition(java.lang.String stateName,
java.lang.String transitionName)
Returns the transition with the given transitionName whose source is the given stateName. |
CpState |
newState(int stateType)
Creates and returns a new CpState of the given state type. |
CpStateTransition |
newTransition(int transitionType)
Creates and returns a new CpStateTransition of the given transition type. |
void |
setInitialStateName(java.lang.String newName)
Sets the name of the policy's initial state |
void |
setPolicyName(java.lang.String newName)
Sets the name of the policy. |
Method Detail |
public java.lang.String getPolicyName()
null
if undefined.public void setPolicyName(java.lang.String newName)
newName
- The new name of the policy.public java.util.Collection getRoles()
Each entry in the Collection is a String.
public void addRole(java.lang.String newRole)
newRole
- The role to be added.public CpState getInitialState()
null
if undefined.public java.lang.String getInitialStateName()
null
if undefined.public void setInitialStateName(java.lang.String newName)
newName
- The name of the new initial state.public int getNumStates()
public java.util.Collection getStates()
Each entry in the Collection is a CpState
.
public CpState getState(java.lang.String name)
name
- The state's name.null
if not found.public void addState(CpState newState)
newState
- The state to be added.public CpStateTransition getTransition(java.lang.String stateName, java.lang.String transitionName)
stateName
- The name of the source state.transitionName
- The name of the transition.null
if not found.public void clear()
public CpState newState(int stateType)
stateType
- The state type.for possible state types.
public CpStateTransition newTransition(int transitionType)
See CpStateTransition
for possible transition types.
transitionType
- The transition type.
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |