com.ibm.ims.dli.tm

Interface IOMessage

public interface IOMessage

The IOMessage interface represents a message either coming from or going to an IMS message queue. It provides a mapping between the data contained in the message and access functions that operate on the class. Client applications can reference individual fields of the message by field name utilizing a wide range of data conversion functions.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	END_CONVERSATION_BLANKS Constant to indicates the end of a transaction.

Method Summary

Modifier and Type	Method and Description
void	clear() Resets all character data fields to blanks, and sets all non-character fields to 0x40 (if EBCDIC) or 0x20 (if ASCII).
int	getActualLength() Returns the actual length (LL) of the IOMessage instance which may differ from the length in the metadata.
java.math.BigDecimal	getBigDecimal(java.lang.String fieldName) Returns the field specified by the parameter as a BigDecimal.
boolean	getBoolean(java.lang.String fieldName) Returns the field specified by the parameter as a boolean.
byte	getByte(java.lang.String fieldName) Returns the field specified by the parameter as a byte.
byte[]	getBytes(java.lang.String fieldName) Returns the field specified by the parameter as a byte array.
java.util.Date	getDate(java.lang.String fieldName) Returns the field specified by the parameter as a java.util.Date.
double	getDouble(java.lang.String fieldName) Returns the field specified by the parameter as a double.
float	getFloat(java.lang.String fieldName) Returns the field specified by the parameter as a float.
int	getInt(java.lang.String fieldName) Returns the field specified by the parameter as an integer.
long	getLong(java.lang.String fieldName) Returns the field specified by the parameter as a long.
short	getShort(java.lang.String fieldName) Returns the field specified by the parameter as a short.
java.sql.Date	getSqlDate(java.lang.String fieldName) Returns the field specified by the parameter as a java.sql.Date.
java.lang.String	getString(java.lang.String fieldName) Returns the field specified by the parameter as a String.
java.lang.String	getTransactionName() Retrieves the IMS transaction name related to this message.
void	setBigDecimal(java.lang.String fieldName, java.math.BigDecimal value) Sets the field indicated by the fieldName parameter to the specified BigDecimal value.
void	setBoolean(java.lang.String fieldName, boolean value) Sets the field indicated by the fieldName parameter to the specified boolean value.
void	setByte(java.lang.String fieldName, byte value) Sets the field indicated by the fieldName parameter to the specified byte value.
void	setBytes(java.lang.String fieldName, byte[] value) Sets the field indicated by the fieldName parameter to the specified byte array value.
void	setDate(java.lang.String fieldName, java.util.Date value) Sets the field indicated by the fieldName parameter to the specified java.util.Date value.
void	setDouble(java.lang.String fieldName, double value) Sets the field indicated by the fieldName parameter to the specified double value.
void	setFloat(java.lang.String fieldName, float value) Sets the field indicated by the fieldName parameter to the specified float value.
void	setInt(java.lang.String fieldName, int value) Sets the field indicated by the fieldName parameter to the specified integer value.
void	setLong(java.lang.String fieldName, long value) Sets the field indicated by the fieldName parameter to the specified long value.
void	setShort(java.lang.String fieldName, short value) Sets the field indicated by the fieldName parameter to the specified short value.
void	setSqlDate(java.lang.String fieldName, java.sql.Date value) Sets the field indicated by the fieldName parameter to the specified java.sql.Date value.
void	setString(java.lang.String fieldName, java.lang.String value) Sets the field indicated by the fieldName parameter to the specified String value.
void	setTransactionName(java.lang.String transactionName) Sets the IMS transaction code name.

Field Detail

END_CONVERSATION_BLANKS

static final java.lang.String END_CONVERSATION_BLANKS

Constant to indicates the end of a transaction.

See Also:

Constant Field Values

Method Detail

getTransactionName

java.lang.String getTransactionName()
                             throws DLIException

Retrieves the IMS transaction name related to this message.

Returns:

trancodeName the name of the IMS transaction code

Throws:

DLIException

TMException - if an error occurs during processing

setTransactionName

void setTransactionName(java.lang.String transactionName)
                 throws DLIException

Sets the IMS transaction code name. You can also use this method to end a conversational transaction and for deferred program switching.

The following code example shows how to end a conversational transaction:

    IOMessage ioMsg = application.getIOMessage("msg_url");
    ioMsg.setTrancodeName(IOMessage.END_CONVERSATION);
 

The following code example shows how to use this method for deferred program switching:

    spaMessage.setTrancodeName("newTran");
    messageQueue.insert(spaMessage, MessageQueue.DEFAULT_DESTINATION);
 

Parameters:

transactionName - the name of the IMS transaction code

Throws:

TMException - if an error occurs during processing

DLIException

getString

java.lang.String getString(java.lang.String fieldName)
                    throws DLIException

Returns the field specified by the parameter as a String.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as a String

Throws:

DLIException - if the field name is not found in the segment

setString

void setString(java.lang.String fieldName,
               java.lang.String value)
        throws DLIException

Sets the field indicated by the fieldName parameter to the specified String value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getBoolean

boolean getBoolean(java.lang.String fieldName)
            throws DLIException

Returns the field specified by the parameter as a boolean.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as a boolean

Throws:

DLIException - if the field name is not found in the segment

setBoolean

void setBoolean(java.lang.String fieldName,
                boolean value)
         throws DLIException

Sets the field indicated by the fieldName parameter to the specified boolean value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getBigDecimal

java.math.BigDecimal getBigDecimal(java.lang.String fieldName)
                            throws DLIException

Returns the field specified by the parameter as a BigDecimal.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as a BigDecimal

Throws:

DLIException - if the field name is not found in the segment

setBigDecimal

void setBigDecimal(java.lang.String fieldName,
                   java.math.BigDecimal value)
            throws DLIException

Sets the field indicated by the fieldName parameter to the specified BigDecimal value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getInt

int getInt(java.lang.String fieldName)
    throws DLIException

Returns the field specified by the parameter as an integer.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as an int

Throws:

DLIException - if the field name is not found in the segment

setInt

void setInt(java.lang.String fieldName,
            int value)
     throws DLIException

Sets the field indicated by the fieldName parameter to the specified integer value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getShort

short getShort(java.lang.String fieldName)
        throws DLIException

Returns the field specified by the parameter as a short.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as a short

Throws:

DLIException - if the field name is not found in the segment

setShort

void setShort(java.lang.String fieldName,
              short value)
       throws DLIException

Sets the field indicated by the fieldName parameter to the specified short value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getLong

long getLong(java.lang.String fieldName)
      throws DLIException

Returns the field specified by the parameter as a long.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as a long

Throws:

DLIException - if the field name is not found in the segment

setLong

void setLong(java.lang.String fieldName,
             long value)
      throws DLIException

Sets the field indicated by the fieldName parameter to the specified long value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getFloat

float getFloat(java.lang.String fieldName)
        throws DLIException

Returns the field specified by the parameter as a float.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as a float

Throws:

DLIException - if the field name is not found in the segment

setFloat

void setFloat(java.lang.String fieldName,
              float value)
       throws DLIException

Sets the field indicated by the fieldName parameter to the specified float value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getDouble

double getDouble(java.lang.String fieldName)
          throws DLIException

Returns the field specified by the parameter as a double.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as a double

Throws:

DLIException - if the field name is not found in the segment

setDouble

void setDouble(java.lang.String fieldName,
               double value)
        throws DLIException

Sets the field indicated by the fieldName parameter to the specified double value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getByte

byte getByte(java.lang.String fieldName)
      throws DLIException

Returns the field specified by the parameter as a byte.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as a byte

Throws:

DLIException - if the field name is not found in the segment

setByte

void setByte(java.lang.String fieldName,
             byte value)
      throws DLIException

Sets the field indicated by the fieldName parameter to the specified byte value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getBytes

byte[] getBytes(java.lang.String fieldName)
         throws DLIException

Returns the field specified by the parameter as a byte array.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as a byte array

Throws:

DLIException - if the field name is not found in the segment

setBytes

void setBytes(java.lang.String fieldName,
              byte[] value)
       throws DLIException

Sets the field indicated by the fieldName parameter to the specified byte array value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getDate

java.util.Date getDate(java.lang.String fieldName)
                throws DLIException

Returns the field specified by the parameter as a java.util.Date.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as a java.util.Date

Throws:

DLIException - if the field name is not found in the segment

setDate

void setDate(java.lang.String fieldName,
             java.util.Date value)
      throws DLIException

Sets the field indicated by the fieldName parameter to the specified java.util.Date value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getSqlDate

java.sql.Date getSqlDate(java.lang.String fieldName)
                  throws DLIException

Returns the field specified by the parameter as a java.sql.Date.

Parameters:

fieldName - the name of the input or output message field

Returns:

the value of the field as a java.sql.Date

Throws:

DLIException - if the field name is not found in the segment

setSqlDate

void setSqlDate(java.lang.String fieldName,
                java.sql.Date value)
         throws DLIException

Sets the field indicated by the fieldName parameter to the specified java.sql.Date value.

Parameters:

fieldName - the name of the input or output message field

value - the new value for the field

Throws:

DLIException - if the field name is not found in the segment or if there is a conversion failure

getActualLength

int getActualLength()
             throws DLIException

Returns the actual length (LL) of the IOMessage instance which may differ from the length in the metadata.

Returns:

the actual length of the IOMessage

Throws:

DLIException

clear

void clear()
    throws DLIException

Resets all character data fields to blanks, and sets all non-character fields to 0x40 (if EBCDIC) or 0x20 (if ASCII).

Calling this method can cause potential problems for ZONEDDECIMAL and PACKEDDECIMAL fields. Any getter method call to these fields will throw a DLIException since the method will look for a sign trailing byte and encounter the blank value which is invalid. To avoid this problem, ensure that following a clear() method call, a setter method is issued to any PACKEDDECIMAL or ZONEDDECIMAL field before a getter method is issued.

Throws:

DLIException