|
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.conversation.base.BasicCpStateTransition
The BasicCpStateTransition class is a straightforward, vanilla-Java implementation of the CpStateTransition interface.
Fields inherited from interface com.ibm.conversation.CpStateTransition |
---|
CHILD_RETURN, NO_TYPE, SEND_MESSAGE, TIMEOUT, TYPE_STRINGS |
Constructor Summary | |
---|---|
BasicCpStateTransition(int newType)
Constructs an BasicCpStateTransition object with the given transition type. |
Method Summary | |
---|---|
java.lang.String |
getChildReturn()
Returns the child-return code. |
MessageDescription |
getMessageDescription()
Returns the MessageDescription for the message associated with this transition. |
java.lang.String |
getName()
Returns the transition's name. |
java.lang.String |
getSenderRole()
Returns the role that is the message sender. |
java.lang.String |
getSourceName()
Returns the name of the transition's source state. |
java.lang.String |
getTargetName()
Returns the name of the transition's target (or destination) state. |
int |
getType()
Return the transition's type. |
int |
getTypeFromString(java.lang.String str)
Returns the transition type matching the given string. |
java.lang.String |
getTypeString()
Returns a string corresponding to the transition's type. |
boolean |
setChildReturn(java.lang.String newReturn)
Sets the child-return code. |
boolean |
setMessageDescription(MessageDescription newDesc)
Sets the MessageDescription for the message associated with this transition. |
void |
setName(java.lang.String newId)
Sets the transition's name. |
boolean |
setSenderRole(java.lang.String newRole)
Sets the role that sends the message. |
void |
setSourceName(java.lang.String newName)
Sets the name of the transition's source state. |
void |
setTargetName(java.lang.String newName)
Sets the name of the transition's target state. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public BasicCpStateTransition(int newType)
See CpStateTransition
for the list of allowed types.
newType
- The transition type.Method Detail |
public int getType()
CpStateTransition
getType
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
public java.lang.String getTypeString()
CpStateTransition
getTypeString
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
public int getTypeFromString(java.lang.String str)
CpStateTransition
Does not change this transition's type. (This method would be static, if static methods were allowed for interfaces.)
getTypeFromString
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
str
- The string for the transition type.public java.lang.String getName()
CpStateTransition
getName
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
public void setName(java.lang.String newId)
CpStateTransition
setName
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
newName
- The new name.public java.lang.String getSourceName()
CpStateTransition
getSourceName
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
null
if there isn't one.public void setSourceName(java.lang.String newName)
CpStateTransition
This does not modify the source state itself, only the name stored in this transition.
Therefore it should be used only in conjunction with calls to the CpState
API
to remove
this transition from the old source state and add it to the new source state
setSourceName
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
newName
- The new source state name.public java.lang.String getTargetName()
CpStateTransition
getTargetName
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
null
if there isn't one.public void setTargetName(java.lang.String newName)
CpStateTransition
This does not modify the target state itself, only the name stored in this transition.
Therefore it should be used only in conjunction with calls to the CpState
API
to remove
this transition from the old target state and add it to the new target state.
setTargetName
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
newName
- The new target state name.public MessageDescription getMessageDescription()
CpStateTransition
This is meaningful only for send-message transitions.
getMessageDescription
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
null
if
there isn't one.public boolean setMessageDescription(MessageDescription newDesc)
CpStateTransition
This is meaningful only for send-message transitions.
setMessageDescription
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
desc
- The MessageDescription for this transitions's message.public java.lang.String getSenderRole()
CpStateTransition
This is meaningful only for send-message transitions.
getSenderRole
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
null
if undefined.public boolean setSenderRole(java.lang.String newRole)
CpStateTransition
This is meaningful only for send-message transitions.
setSenderRole
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
newRole
- the role that sends the mesage.public java.lang.String getChildReturn()
CpStateTransition
This is meaningful only for child-return transitions.
getChildReturn
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
null
if undefined.public boolean setChildReturn(java.lang.String newReturn)
CpStateTransition
This is meaningful only for child-return transitions.
setChildReturn
in interface CpStateTransition
com.ibm.conversation.CpStateTransition
newReturn
- The new child-return code.
|
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 |