|
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 |
java.lang.Object | +--com.ibm.able.conversation.State
Class representing a state in a conversation as defined by a Conversation Policy. Each state has the following associated data
OLD VERSION -- TO BE DELETED Replaced by com.ibm.conversation.base.BasicCpState
(1) a name
(2) a type which could be normal,terminal or load-child
(3) a role thats is active at that state (optionally)
(4) a time-out value for staying at that state (optionally)
(5) a set of transitions possible from that state (optionally)
Field Summary | |
---|---|
protected static long |
serialVersionUID
Serialized version identifier in form YYYYMMDDVerRelModxx |
Constructor Summary | |
---|---|
State()
Create a new default State object |
|
State(State s)
Create a new State object by copying all the information from the argument State |
Method Summary | |
---|---|
void |
addTransition(Transition transition)
Adds a new transition to the set of transitions possible from the state |
java.lang.String |
getActiveRole()
Returns the role active at that state |
java.util.Hashtable |
getChildConversationPolicyParams()
Returns the child conversation policy parameters associated with the state |
java.lang.String |
getName()
Returns the name of the state. |
int |
getTimeoutInterval()
Returns the time-out value asociated with the state |
Transition |
getTransition(java.lang.String id)
Returns the transition identified by the id supplied |
java.util.Enumeration |
getTransitionNames()
Returns an enumeration of all transition names(ids) from the state |
java.util.Enumeration |
getTransitions()
Returns the set of transitions possible from the state |
java.lang.String |
getType()
Returns the type of the state |
boolean |
isLoadChildState()
Check if the state is a load-child state |
boolean |
isNormalState()
Check if the state is a normal state |
boolean |
isTerminalState()
Check if the state is a terminal state |
void |
setActiveRole(java.lang.String role)
Sets the role name that is active in that state |
void |
setChildConversationPolicyParams(java.util.Hashtable params)
Sets child conversation policy parameters such as rolemaps when loading a child CP |
void |
setName(java.lang.String name)
Sets the name of the state |
void |
setTimeoutInterval(int timeout)
Sets the time-out period for the state |
void |
setTransitions(java.util.Hashtable transitions)
Sets the transitions possible from the state |
void |
setType(java.lang.String type)
Sets the type of the state |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final long serialVersionUID
Constructor Detail |
public State()
public State(State s)
s
- the original state from which the copy is constructedMethod Detail |
public void setName(java.lang.String name)
name
- name to be assigned to the statepublic void setType(java.lang.String type)
type
- type to be assigned to the statepublic void addTransition(Transition transition)
transition
- The Transition to be addedpublic void setTransitions(java.util.Hashtable transitions)
transitions
- Hashtable indexed by the transition name(id) and containing the
corresponding transition elementspublic void setTimeoutInterval(int timeout)
timeout
- The timeout value to be associated with the statepublic void setActiveRole(java.lang.String role)
role
- The role that is active in that statepublic void setChildConversationPolicyParams(java.util.Hashtable params)
params
- Hashtable of parameters associated with loading child CPspublic java.lang.String getName()
public java.lang.String getType()
public java.util.Enumeration getTransitions()
public Transition getTransition(java.lang.String id)
id
- the identifier for the transition
public java.util.Enumeration getTransitionNames()
public int getTimeoutInterval()
public java.lang.String getActiveRole()
public java.util.Hashtable getChildConversationPolicyParams()
public boolean isNormalState()
public boolean isTerminalState()
public boolean isLoadChildState()
|
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 |