com.ibm.dse.services.otma
Class OTMAMessage

java.lang.Object
  |
  +--com.ibm.dse.services.otma.OTMAMessage

public class OTMAMessage
extends java.lang.Object

This OTMAMessage class represents a OTMA message with message characteristics.


Field Summary
static java.lang.String COMPID
           
 
Constructor Summary
OTMAMessage()
          This constructor creates a OTMAMessage object.
 
Method Summary
 byte[] getConversationId()
          Returns conversationId in case transaction is conversational.
 java.lang.String getErrorMessage()
          Returns error message from IMS when error produced.
 java.lang.String getLTERM()
          Returns the LTERM from IMS.
 java.lang.String getMFSModName()
          Returns the name of the MFSModName from IMS.
 java.lang.String getReasonCode()
          Returns a String with the reason codes concatenated.
 int getReceivedLength()
          Returns the total of available message segment lengths.
 int[] getResponseSegments()
          Returns an array to hold the number of segments sent by IMS.
 java.lang.String getResponseString()
          Returns the message replied from IMS.
 int getReturnCode()
          Returns the name of the returnCode from IMS.
 boolean isConversational()
          Returns whether this interaction with IMS is conversational.
 boolean isTimeout()
          Returns if timeout is achieved in the transaction.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPID

public static final java.lang.String COMPID
Constructor Detail

OTMAMessage

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

getConversationId

public byte[] getConversationId()
Returns conversationId in case transaction is conversational. This ID has to be used in the following sendReceive interactions for the same conversation.
Returns:
byte []

getErrorMessage

public java.lang.String getErrorMessage()
Returns error message from IMS when error produced.
Returns:
java.lang.String

getLTERM

public java.lang.String getLTERM()

Returns the LTERM from IMS.

Returns:
java.lang.String LTERM.

getMFSModName

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

getReasonCode

public java.lang.String getReasonCode()
Returns a String with the reason codes concatenated. Actualized an when an error is produced.
Returns:
java.lang.String

getReceivedLength

public int getReceivedLength()
Returns the total of available message segment lengths.
Returns:
int

getResponseSegments

public int[] getResponseSegments()
Returns an array to hold the number of segments sent by IMS. First element contains the number of elements in the array.
Returns:
int []

getResponseString

public java.lang.String getResponseString()
Returns the message replied from IMS.
Returns:
java.lang.String.

getReturnCode

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

isConversational

public boolean isConversational()
Returns whether this interaction with IMS is conversational.
Returns:
boolean

isTimeout

public boolean isTimeout()
Returns if timeout is achieved in the transaction.
Returns:
boolean.