com.ibm.mq.headers

Class MQTM

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.headers.internal.Header
com.ibm.mq.headers.MQTM

All implemented interfaces:

public class MQTM
extends com.ibm.mq.headers.internal.Header

MQTM header class.

        struct tagMQTM 
        {
                MQCHAR4    StrucId;      // Structure identifier 
                MQLONG     Version;      // Structure version number
                MQCHAR48   QName;        // Name of triggered queue
                MQCHAR48   ProcessName;  // Name of process object
                MQCHAR64   TriggerData;  // Trigger data
                MQLONG     ApplType;     // Application type
                MQCHAR256  ApplId;       // Application identifier
                MQCHAR128  EnvData;      // Environment data
                MQCHAR128  UserData;     // User data
        };

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.mq.headers.MQHeader
`MQHeader.Field`

Field Summary

Modifier and Type	Field and Description
static int	`SIZE` Size of an MQTM structure in bytes

Fields inherited from class com.ibm.mq.headers.internal.Header
`DEFAULT_CCSID, DEFAULT_ENCODING`

Fields inherited from class com.ibm.mq.jmqi.JmqiObject
`COMP_JM, COMP_JN, COMP_JO`

Constructor Summary

Constructor and Description
`MQTM()` Constructs an MQTM instance with default field values.
`MQTM(java.io.DataInput message)` Constructs an MQTM instance populated from an MQMessage.
`MQTM(java.io.DataInput message,int encoding,int characterSet)` Constructs an MQTM instance populated from a DataInput source.

Method Summary

Modifier and Type	Method and Description
java.lang.String	`getApplId()` gets the application identifier
int	`getApplType()` gets the application type
java.lang.String	`getEnvData()` gets the environment data
java.lang.String	`getProcessName()` gets the Name of process object
java.lang.String	`getQName()` gets the Name of triggered queue
java.lang.String	`getStrucId()` Get the structure identifier; the value will be MQTM_STRUC_ID
java.lang.String	`getTriggerData()` gets the trigger data
java.lang.String	`getUserData()` gets the user data
int	`getVersion()` Get the Structure version number
void	`setApplId(java.lang.String value)` sets the application identifier
void	`setApplType(int value)` sets the application type
void	`setEnvData(java.lang.String value)` sets the environment data
void	`setProcessName(java.lang.String value)` sets the Name of process object
void	`setQName(java.lang.String value)` sets the Name of triggered queue
void	`setTriggerData(java.lang.String value)` sets the trigger data
void	`setUserData(java.lang.String value)` sets the user data

Methods inherited from class com.ibm.mq.headers.internal.Header
`characterSet, encoding, fields, getBytesValue, getCharValue, getCharValue, getIntValue, getJmqiEnv, getStringValue, getValue, headerType, read, read, read, setBytesValue, setCharValue, setCharValue, setIntValue, setStringValue, setValue, size, store, store, toString, type, validate, write, write`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

SIZE

public static final int SIZE

Size of an MQTM structure in bytes

Constructor Detail

MQTM

public MQTM()

Constructs an MQTM instance with default field values.

MQTM

public MQTM(java.io.DataInput message)
throws MQDataException
java.io.IOException

Constructs an MQTM instance populated from an MQMessage.

Parameters:

message - the message to read

Throws:

MQDataException - if the message content does not yield a valid MQTM stucture

java.io.IOException - if there is a problem reading the message content

MQTM

public MQTM(java.io.DataInput message,
int encoding,
int characterSet)
throws MQDataException
java.io.IOException

Constructs an MQTM instance populated from a DataInput source.

Parameters:

message - the MQMessage or other DataInput source to read

encoding - the initial numeric encoding of the data in the message

characterSet - the initial CCSID of the data in the message

Throws:

MQDataException - if the message content does not yield a valid MQTM stucture

java.io.IOException - if there is a problem reading the message content

Method Detail

getStrucId

public java.lang.String getStrucId( )

Get the structure identifier; the value will be MQTM_STRUC_ID

Returns:

the structure identifier

getVersion

public int getVersion()

Get the Structure version number

Returns:

the Structure version number

getQName

public java.lang.String getQName( )

gets the Name of triggered queue

Returns:

the Name of triggered queue

setQName

public void setQName(java.lang.String value)

sets the Name of triggered queue

Parameters:

value - the Name of triggered queue

getProcessName

public java.lang.String getProcessName( )

gets the Name of process object

Returns:

the Name of process object

setProcessName

public void setProcessName(java.lang.String value)

sets the Name of process object

Parameters:

value - the Name of process object

getTriggerData

public java.lang.String getTriggerData( )

gets the trigger data

Returns:

the trigger data

setTriggerData

public void setTriggerData(java.lang.String value)

sets the trigger data

Parameters:

value - the trigger data

getApplType

public int getApplType()

gets the application type

Returns:

the application type

setApplType

public void setApplType(int value)

sets the application type

Parameters:

value - the application type

getApplId

public java.lang.String getApplId( )

gets the application identifier

Returns:

the application identifier

setApplId

public void setApplId(java.lang.String value)

sets the application identifier

Parameters:

value - the application identifier

getEnvData

public java.lang.String getEnvData( )

gets the environment data

Returns:

the environment data

setEnvData

public void setEnvData(java.lang.String value)

sets the environment data

Parameters:

value - the environment data

getUserData

public java.lang.String getUserData( )

gets the user data

Returns:

the user data

setUserData

public void setUserData(java.lang.String value)

sets the user data

Parameters:

value - the user data