ABLE 2.0.0 07/02/2003 10:25:01

com.ibm.able.conversation
Class Transition

java.lang.Object
  |
  +--com.ibm.able.conversation.Transition
All Implemented Interfaces:
java.io.Serializable

public class Transition
extends java.lang.Object
implements java.io.Serializable

Class that represents a transition during a conversation from one state to another.

OLD VERSION -- TO BE DELETED Replaced by com.ibm.conversation.CpStateTransition.

Transitions could happen as a result of the following events:

(1) Sending/receiving of messages

(2) Time-out from a particular state

(3) Loading/returning child conversation policies

All transitions have the following associated data

(1) A string identifier(name)

(2) Names of the source and target states connected by the transition

(3) Event identifiers. "time-out" events have no parameters. "send-message" events have schema and encoding parameters.

See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          Serialized version identifier in form YYYYMMDDVerRelModxx
 
Constructor Summary
Transition()
          Creates a new (default) transition object
Transition(Transition t)
          Creates a new transition object that is a copy of the argument transition object
 
Method Summary
 java.lang.String getEvent()
          Returns the name of the event associated with the transition
 java.lang.String getEventParam(java.lang.String key)
          Returns a particular event parameter associated with the transition-event
 java.util.Hashtable getEventParams()
          Returns the parameters associated with the transition-event
 java.lang.String getId()
          Returns the identifier(name) of the transition
 java.lang.String getSource()
          Returns the name of source state of the transition
 java.lang.String getTarget()
          Returns the name of the target state of the transition
 void setEvent(java.lang.String eventName)
          Sets the event name associated with the transition
 void setEventParams(java.util.Hashtable parameters)
          Sets the event parameters associated with the transition
 void setId(java.lang.String id)
          Sets the identifier for the transition
 void setSource(java.lang.String sourceState)
          Sets the name of the source state for the transition
 void setTarget(java.lang.String targetState)
          Sets the name of the target state for the transition
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

protected static final long serialVersionUID
Serialized version identifier in form YYYYMMDDVerRelModxx
Constructor Detail

Transition

public Transition()
Creates a new (default) transition object

Transition

public Transition(Transition t)
Creates a new transition object that is a copy of the argument transition object

Parameters:
t - the transition object to be copied
Method Detail

setId

public void setId(java.lang.String id)
Sets the identifier for the transition

Parameters:
id - identifier to be associated with the transition

setSource

public void setSource(java.lang.String sourceState)
Sets the name of the source state for the transition

Parameters:
sourceName - name of the source state

setTarget

public void setTarget(java.lang.String targetState)
Sets the name of the target state for the transition

Parameters:
targetName - name of the target state

setEvent

public void setEvent(java.lang.String eventName)
Sets the event name associated with the transition

Parameters:
eventName - name of the event

setEventParams

public void setEventParams(java.util.Hashtable parameters)
Sets the event parameters associated with the transition

Parameters:
parameters - hashtable of parameters associated with the transition

getId

public java.lang.String getId()
Returns the identifier(name) of the transition

Returns:
identifier(name) of the transition or empty string if previously not set

getSource

public java.lang.String getSource()
Returns the name of source state of the transition

Returns:
name of the source state or empty string if previously not set

getTarget

public java.lang.String getTarget()
Returns the name of the target state of the transition

Returns:
name of the target state or empty string if previously not set

getEvent

public java.lang.String getEvent()
Returns the name of the event associated with the transition

Returns:
name of the event or empty string if previously not set

getEventParams

public java.util.Hashtable getEventParams()
Returns the parameters associated with the transition-event

Returns:
hastable of event parameters or null if previously not set

getEventParam

public java.lang.String getEventParam(java.lang.String key)
Returns a particular event parameter associated with the transition-event

Parameters:
key - Name of the event parameter

Returns:
Value of the parameter if present, null otherwise

ABLE 2.0.0 07/02/2003 10:25:01

(C) Copyright IBM Corporation 1999, 2003