com.ibm.dse.services.itoc
Class ITOCMessage

java.lang.Object
  |
  +--com.ibm.dse.services.comms.CCMessage
        |
        +--com.ibm.dse.services.itoc.ITOCMessage

public class ITOCMessage
extends CCMessage

This class represents an ITOC message with its characteristics.


Field Summary
 boolean isConversational
          If true conversationOn flag received from the IMS.
 java.lang.String LTERM
          The name of the IMS LTERM.
 java.lang.String MFSModName
          The name of the MFS mod name.
 int reasonCode
          The value of transaction reason code from the IMS.
 java.lang.String[] responseSegments
          The response segments from the IMS.
 java.lang.String responseString
          The concatenated response segments from de IMS.
 int returnCode
          The value of transaction return code from the IMS.
 boolean timeout
          If timeout is achieved, application set this value to true.
 
Fields inherited from class com.ibm.dse.services.comms.CCMessage
dataReceived, dataSent, receiveRC, timeout
 
Constructor Summary
ITOCMessage()
          This constructor creates a ITOCMessage object.
 
Method Summary
 java.lang.String getLTERM()
          Returns the name of the LTERM from the ITOCMessage.
 java.lang.String getMFSModName()
          Returns the name of the MFSModName from the ITOCMessage.
 int getReasonCode()
          Returns the name of the reasonCode from the ITOCMessage.
 java.lang.String[] getResponseSegments()
          Returns the value of the responseSegments from the ITOCMessage.
 java.lang.String getResponseString()
          Returns the concatenated response string from the ITOCMessage.
 int getReturnCode()
          Returns the name of the returnCode from the ITOCMessage.
 boolean isIsConversational()
          Returns true if communication is conversational.
 boolean isTimeout()
          Returns true if timeout is achieved in the transaction.
 void setIsConversational(boolean newIsConversational)
          Sets the value of the isConversational property.
 void setLTERM(java.lang.String newLTERM)
          Sets the value of the LTERM property.
 void setMFSModName(java.lang.String newMFSModName)
          Sets the value of the MFSModName property..
 void setReasonCode(int newReasonCode)
          Sets the value of the reasonCode property.
 void setResponseSegments(java.lang.String[] newResponseSegments)
          Sets the array of string, responseSegmentsfrom the ITOC message
 void setResponseString(java.lang.String newResponseString)
          Sets the concatenated response segments, responseString from the ITOC message
 void setReturnCode(int newReturnCode)
          Sets the value of the returnCode property.
 void setTimeout(boolean newTimeout)
          Sets the value of the timeout property.
 
Methods inherited from class com.ibm.dse.services.comms.CCMessage
finalize, getDataReceived, getDataSent, getReceiveRC, getTimeout, setDataReceived, setDataSent, setReceiveRC
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LTERM

public java.lang.String LTERM
The name of the IMS LTERM. This field can be set to a valid name or to blanks

MFSModName

public java.lang.String MFSModName
The name of the MFS mod name. User can request this value to IMS

responseString

public java.lang.String responseString
The concatenated response segments from de IMS.

timeout

public boolean timeout
If timeout is achieved, application set this value to true. Default value to false

returnCode

public int returnCode
The value of transaction return code from the IMS.

reasonCode

public int reasonCode
The value of transaction reason code from the IMS.

responseSegments

public java.lang.String[] responseSegments
The response segments from the IMS.

isConversational

public boolean isConversational
If true conversationOn flag received from the IMS.
Constructor Detail

ITOCMessage

public ITOCMessage()
This constructor creates a ITOCMessage object.
Method Detail

getLTERM

public java.lang.String getLTERM()
Returns the name of the LTERM from the ITOCMessage.
Returns:
java.lang.String - The current value of LTERM.

getMFSModName

public java.lang.String getMFSModName()
Returns the name of the MFSModName from the ITOCMessage.
Returns:
java.lang.String - The current value of MFSModName.

getReasonCode

public int getReasonCode()
Returns the name of the reasonCode from the ITOCMessage.
Returns:
int - The current value of reasonCode.

getResponseSegments

public java.lang.String[] getResponseSegments()
Returns the value of the responseSegments from the ITOCMessage.
Returns:
java.lang.String - The current value of responseSegments.

getResponseString

public java.lang.String getResponseString()
Returns the concatenated response string from the ITOCMessage.
Returns:
java.lang.String.

getReturnCode

public int getReturnCode()
Returns the name of the returnCode from the ITOCMessage.
Returns:
int - The current value of returnCode.

isIsConversational

public boolean isIsConversational()
Returns true if communication is conversational.
Returns:
boolean.The isConversational property value read from the message.

isTimeout

public boolean isTimeout()
Returns true if timeout is achieved in the transaction.
Returns:
boolean.The timeout property value read from the message.

setIsConversational

public void setIsConversational(boolean newIsConversational)
Sets the value of the isConversational property.
Parameters:
newIsConversational - boolean

setLTERM

public void setLTERM(java.lang.String newLTERM)
Sets the value of the LTERM property.
Parameters:
newLTERM - java.lang.String

setMFSModName

public void setMFSModName(java.lang.String newMFSModName)
Sets the value of the MFSModName property..
Parameters:
newMFSModName - java.lang.String

setReasonCode

public void setReasonCode(int newReasonCode)
Sets the value of the reasonCode property.
Parameters:
newReasonCode - int

setResponseSegments

public void setResponseSegments(java.lang.String[] newResponseSegments)
Sets the array of string, responseSegmentsfrom the ITOC message
Parameters:
newResponseSegments - java.lang.String[]

setResponseString

public void setResponseString(java.lang.String newResponseString)
Sets the concatenated response segments, responseString from the ITOC message
Parameters:
newResponseString - java.lang.String

setReturnCode

public void setReturnCode(int newReturnCode)
Sets the value of the returnCode property.
Parameters:
newReturnCode - int

setTimeout

public void setTimeout(boolean newTimeout)
Sets the value of the timeout property.
Overrides:
setTimeout in class CCMessage
Parameters:
newTimeout - boolean