MQCIH

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

All Implemented Interfaces:: MQChainable, MQData, MQHeader

public class MQCIH
extends com.ibm.mq.headers.internal.Header
implements MQChainable

MQCIH (CICS bridge header) header class.

    struct tagMQCIH {
                MQCHAR4  StrucId;             // Structure identifier
                MQLONG   Version;             // Structure version number
                MQLONG   StrucLength;         // Length of MQCIH structure
                MQLONG   Encoding;            // Reserved
                MQLONG   CodedCharSetId;      // Reserved
                MQCHAR8  Format;              // MQ format name of data that follows MQCIH
                MQLONG   Flags;               // Flags
                MQLONG   ReturnCode;          // Return code from bridge
                MQLONG   CompCode;            // MQ completion code or CICS EIBRESP
        MQLONG   Reason;              // MQ reason or feedback code, or CICS EIBRESP2
        MQLONG   UOWControl;          // Unit-of-work control
        MQLONG   GetWaitInterval;     // Wait interval for MQGET call issued by bridge task
        MQLONG   LinkType;            // Link type
        MQLONG   OutputDataLength;    // Output COMMAREA data length
        MQLONG   FacilityKeepTime;    // Bridge facility release time
        MQLONG   ADSDescriptor;       // Send/receive ADS descriptor
        MQLONG   ConversationalTask;  // Whether task can be conversational
        MQLONG   TaskEndStatus;       // Status at end of task
        MQBYTE8  Facility;            // Bridge facility token
        MQCHAR4  Function;            // MQ call name or CICS EIBFN function
        MQCHAR4  AbendCode;           // Abend code
        MQCHAR8  Authenticator;       // Password or passticket
        MQCHAR8  Reserved1;           // Reserved
        MQCHAR8  ReplyToFormat;       // MQ format name of reply message
        MQCHAR4  RemoteSysId;         // Remote CICS system id to use
        MQCHAR4  RemoteTransId;       // CICS RTRANSID to use
        MQCHAR4  TransactionId;       // Transaction to attach
        MQCHAR4  FacilityLike;        // Terminal emulated attributes
        MQCHAR4  AttentionId;         // AID key
        MQCHAR4  StartCode;           // Transaction start code
        MQCHAR4  CancelCode;          // Abend transaction code
        MQCHAR4  NextTransactionId;   // Next transaction to attach
        MQCHAR8  Reserved2;           // Reserved
        MQCHAR8  Reserved3;           // Reserved
        // Ver:1
        MQLONG   CursorPosition;      // Cursor position
                MQLONG   ErrorOffset;         // Offset of error in message
                MQLONG   InputItem;           // Reserved
                MQLONG   Reserved4;           // Reserved
                // Ver:2
   };

Nested Class Summary
- Nested classes/interfaces inherited from interface com.ibm.mq.headers.MQHeader
  MQHeader.Field

Field Summary
- Fields inherited from class com.ibm.mq.headers.internal.Header
  DEFAULT_CCSID, DEFAULT_ENCODING, delegate
- Fields inherited from class com.ibm.mq.jmqi.JmqiObject
  COMP_JM, COMP_JN, COMP_JO

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`format()`
`java.lang.String`	`getAbendCode()` get the Abend code
`int`	`getADSDescriptor()` get the Send/receive ADS descriptor
`java.lang.String`	`getAttentionId()` get the AID key
`java.lang.String`	`getAuthenticator()` get the Password or passticket
`java.lang.String`	`getCancelCode()` get the Abend transaction code
`int`	`getCodedCharSetId()` Get the Character set identifier of data that follows.
`int`	`getCompCode()` get the completion code
`int`	`getConversationalTask()` get the indication whether task can be conversational
`int`	`getCursorPosition()` get the Cursor position
`int`	`getEncoding()` Get the numeric encoding of the data that follows.
`int`	`getErrorOffset()` get the Offset of error in message
`byte[]`	`getFacility()` get the Bridge facility token
`int`	`getFacilityKeepTime()` get the Bridge facility release time
`java.lang.String`	`getFacilityLike()` get the Terminal emulated attributes
`int`	`getFlags()` get the Flags
`java.lang.String`	`getFormat()` get the MQ format name of data that follows MQCIH
`java.lang.String`	`getFunction()` get the MQ call name or CICS EIBFN function
`int`	`getGetWaitInterval()` get the wait interval
`int`	`getInputItem()` get the value of the InputItem field
`int`	`getLinkType()` get the link type
`java.lang.String`	`getNextTransactionId()` get the Next transaction to attach
`int`	`getOutputDataLength()` get the Output COMMAREA data length
`int`	`getReason()` get the reason code
`java.lang.String`	`getRemoteSysId()` get the Remote CICS system id to use
`java.lang.String`	`getRemoteTransId()` get the CICS RTRANSID to use
`java.lang.String`	`getReplyToFormat()` set the MQ format name of reply message
`int`	`getReturnCode()` get the return code
`java.lang.String`	`getStartCode()` get the Transaction start code
`java.lang.String`	`getStrucId()` Get the structure identifier; the value will be MQCIH_STRUC_ID
`int`	`getStrucLength()` Get the length of the structure.
`int`	`getTaskEndStatus()` get the status at end of task
`java.lang.String`	`getTransactionId()` get the Transaction to attach
`int`	`getUOWControl()` get the Unit-of-work control value
`int`	`getVersion()` Get the Structure version number
`int`	`nextCharacterSet()`
`void`	`nextCharacterSet(int value)` Sets the CCSID of the next header or message content.
`int`	`nextEncoding()`
`void`	`nextEncoding(int value)` Sets the numeric encoding of the next header or message content.
`java.lang.String`	`nextFormat()`
`void`	`nextFormat(java.lang.String value)` Sets the format of the next header or message content.
`void`	`setAbendCode(java.lang.String value)` set the Abend code
`void`	`setADSDescriptor(int value)` set the Send/receive ADS descriptor
`void`	`setAttentionId(java.lang.String value)` set the AID key
`void`	`setAuthenticator(java.lang.String value)` set the Password or passticket
`void`	`setCancelCode(java.lang.String value)` set the Abend transaction code
`void`	`setCodedCharSetId(int value)` Set the Character set identifier of data that follows.
`void`	`setCompCode(int value)` set the completion code
`void`	`setConversationalTask(int value)` set the indication whether task can be conversational
`void`	`setCursorPosition(int value)` set the Cursor position
`void`	`setEncoding(int value)` Set the numeric encoding of the data that follows.
`void`	`setErrorOffset(int value)` set the Offset of error in message
`void`	`setFacility(byte[] value)` set the Bridge facility token
`void`	`setFacilityKeepTime(int value)` set the Bridge facility release time
`void`	`setFacilityLike(java.lang.String value)` set the Terminal emulated attributes
`void`	`setFlags(int value)` set the Flags
`void`	`setFormat(java.lang.String value)` set the MQ format name of data that follows MQCIH
`void`	`setFunction(java.lang.String value)` set the MQ call name or CICS EIBFN function
`void`	`setGetWaitInterval(int value)` set the wait interval
`void`	`setInputItem(int value)` set the value of the InputItem field
`void`	`setLinkType(int value)` set the link type
`void`	`setNextTransactionId(java.lang.String value)` set the Next transaction to attach
`void`	`setOutputDataLength(int value)` set the Output COMMAREA data length
`void`	`setReason(int value)` set the reason code
`void`	`setRemoteSysId(java.lang.String value)` set the Remote CICS system id to use
`void`	`setRemoteTransId(java.lang.String value)` set the CICS RTRANSID to use
`void`	`setReplyToFormat(java.lang.String value)` set the MQ format name of reply message
`void`	`setReturnCode(int value)` set the return code
`void`	`setStartCode(java.lang.String value)` set the Transaction start code
`void`	`setTaskEndStatus(int value)` set the status at end of task
`void`	`setTransactionId(java.lang.String value)` set the Transaction to attach
`void`	`setUOWControl(int value)` set the Unit-of-work control value
`void`	`setVersion(int value)` Set the Structure version number

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

- Constructor Detail
  - MQCIH
```
public MQCIH()
```
    Constructs an MQCIH instance with default field values.
  - MQCIH
```
public MQCIH(java.io.DataInput message)
      throws MQDataException,
             java.io.IOException
```
    Constructs an MQCIH instance populated from an MQMessage.
    
    Parameters:
    message - the message to read
    
    Throws:
    
    MQDataException - if the message content does not yield a valid MQCIH stucture
    
    java.io.IOException - if there is a problem reading the message content
  - MQCIH
```
public MQCIH(java.io.DataInput message,
     int encoding,
     int characterSet)
      throws MQDataException,
             java.io.IOException
```
    Constructs an MQCIH 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 MQCIH 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 MQCIH_STRUC_ID
    
    Returns:
    the structure identifier
  - getVersion
```
public int getVersion()
```
    Get the Structure version number
    
    Returns:
    the Structure version number
  - setVersion
```
public void setVersion(int value)
```
    Set the Structure version number
    
    Parameters:
    value - the Structure version number
  - getStrucLength
```
public int getStrucLength()
```
    Get the length of the structure.
    
    Returns:
    the structure length.
  - getEncoding
```
public int getEncoding()
```
    Get the numeric encoding of the data that follows.
    
    Returns:
    the numeric encoding. A combination of MQENC_* values.
  - setEncoding
```
public void setEncoding(int value)
```
    Set the numeric encoding of the data that follows.
    
    Parameters:
    value - the numeric encoding. A combination of MQENC_* values.
  - getCodedCharSetId
```
public int getCodedCharSetId()
```
    Get the Character set identifier of data that follows.
    
    Returns:
    the Character set identifier.
  - setCodedCharSetId
```
public void setCodedCharSetId(int value)
```
    Set the Character set identifier of data that follows.
    
    Parameters:
    value - the Character set identifier.
  - getFormat
```
public java.lang.String getFormat()
```
    get the MQ format name of data that follows MQCIH
    
    Returns:
    MQ format name
  - setFormat
```
public void setFormat(java.lang.String value)
```
    set the MQ format name of data that follows MQCIH
    
    Parameters:
    value - the MQ format name
  - getFlags
```
public int getFlags()
```
    get the Flags
    
    Returns:
    the Flags
  - setFlags
```
public void setFlags(int value)
```
    set the Flags
    
    Parameters:
    value - the Flags value to set
  - getReturnCode
```
public int getReturnCode()
```
    get the return code
    
    Returns:
    the return code
  - setReturnCode
```
public void setReturnCode(int value)
```
    set the return code
    
    Parameters:
    value - the return code
  - getCompCode
```
public int getCompCode()
```
    get the completion code
    
    Returns:
    the completion code
  - setCompCode
```
public void setCompCode(int value)
```
    set the completion code
    
    Parameters:
    value - the completion code
  - getReason
```
public int getReason()
```
    get the reason code
    
    Returns:
    the reason code
  - setReason
```
public void setReason(int value)
```
    set the reason code
    
    Parameters:
    value - the reason code
  - getUOWControl
```
public int getUOWControl()
```
    get the Unit-of-work control value
    
    Returns:
    the Unit-of-work control value
  - setUOWControl
```
public void setUOWControl(int value)
```
    set the Unit-of-work control value
    
    Parameters:
    value - the Unit-of-work control value
  - getGetWaitInterval
```
public int getGetWaitInterval()
```
    get the wait interval
    
    Returns:
    the wait interval
  - setGetWaitInterval
```
public void setGetWaitInterval(int value)
```
    set the wait interval
    
    Parameters:
    value - the wait interval
  - getLinkType
```
public int getLinkType()
```
    get the link type
    
    Returns:
    link type
  - setLinkType
```
public void setLinkType(int value)
```
    set the link type
    
    Parameters:
    value - the link type
  - getOutputDataLength
```
public int getOutputDataLength()
```
    get the Output COMMAREA data length
    
    Returns:
    the Output COMMAREA data length
  - setOutputDataLength
```
public void setOutputDataLength(int value)
```
    set the Output COMMAREA data length
    
    Parameters:
    value - the Output COMMAREA data length
  - getFacilityKeepTime
```
public int getFacilityKeepTime()
```
    get the Bridge facility release time
    
    Returns:
    the Bridge facility release time
  - setFacilityKeepTime
```
public void setFacilityKeepTime(int value)
```
    set the Bridge facility release time
    
    Parameters:
    value - the Bridge facility release time
  - getADSDescriptor
```
public int getADSDescriptor()
```
    get the Send/receive ADS descriptor
    
    Returns:
    the Send/receive ADS descriptor
  - setADSDescriptor
```
public void setADSDescriptor(int value)
```
    set the Send/receive ADS descriptor
    
    Parameters:
    value - the Send/receive ADS descriptor
  - getConversationalTask
```
public int getConversationalTask()
```
    get the indication whether task can be conversational
    
    Returns:
    the indication whether task can be conversational
  - setConversationalTask
```
public void setConversationalTask(int value)
```
    set the indication whether task can be conversational
    
    Parameters:
    value - the indication whether task can be conversational
  - getTaskEndStatus
```
public int getTaskEndStatus()
```
    get the status at end of task
    
    Returns:
    the status at end of task
  - setTaskEndStatus
```
public void setTaskEndStatus(int value)
```
    set the status at end of task
    
    Parameters:
    value - the status at end of task
  - getFacility
```
public byte[] getFacility()
```
    get the Bridge facility token
    
    Returns:
    the Bridge facility token
  - setFacility
```
public void setFacility(byte[] value)
```
    set the Bridge facility token
    
    Parameters:
    value - the Bridge facility token
  - getFunction
```
public java.lang.String getFunction()
```
    get the MQ call name or CICS EIBFN function
    
    Returns:
    the MQ call name or CICS EIBFN function
  - setFunction
```
public void setFunction(java.lang.String value)
```
    set the MQ call name or CICS EIBFN function
    
    Parameters:
    value - the MQ call name or CICS EIBFN function
  - getAbendCode
```
public java.lang.String getAbendCode()
```
    get the Abend code
    
    Returns:
    the Abend code
  - setAbendCode
```
public void setAbendCode(java.lang.String value)
```
    set the Abend code
    
    Parameters:
    value - the Abend code
  - getAuthenticator
```
public java.lang.String getAuthenticator()
```
    get the Password or passticket
    
    Returns:
    the Password or passticket
  - setAuthenticator
```
public void setAuthenticator(java.lang.String value)
```
    set the Password or passticket
    
    Parameters:
    value - the Password or passticket
  - getReplyToFormat
```
public java.lang.String getReplyToFormat()
```
    set the MQ format name of reply message
    
    Returns:
    the MQ format name of reply message
  - setReplyToFormat
```
public void setReplyToFormat(java.lang.String value)
```
    set the MQ format name of reply message
    
    Parameters:
    value - the MQ format name of reply message
  - getRemoteSysId
```
public java.lang.String getRemoteSysId()
```
    get the Remote CICS system id to use
    
    Returns:
    the Remote CICS system id to use
  - setRemoteSysId
```
public void setRemoteSysId(java.lang.String value)
```
    set the Remote CICS system id to use
    
    Parameters:
    value - the Remote CICS system id to use
  - getRemoteTransId
```
public java.lang.String getRemoteTransId()
```
    get the CICS RTRANSID to use
    
    Returns:
    the CICS RTRANSID to use
  - setRemoteTransId
```
public void setRemoteTransId(java.lang.String value)
```
    set the CICS RTRANSID to use
    
    Parameters:
    value - the CICS RTRANSID to use
  - getTransactionId
```
public java.lang.String getTransactionId()
```
    get the Transaction to attach
    
    Returns:
    the Transaction to attach
  - setTransactionId
```
public void setTransactionId(java.lang.String value)
```
    set the Transaction to attach
    
    Parameters:
    value - the Transaction to attach
  - getFacilityLike
```
public java.lang.String getFacilityLike()
```
    get the Terminal emulated attributes
    
    Returns:
    the Terminal emulated attributes
  - setFacilityLike
```
public void setFacilityLike(java.lang.String value)
```
    set the Terminal emulated attributes
    
    Parameters:
    value - the Terminal emulated attributes
  - getAttentionId
```
public java.lang.String getAttentionId()
```
    get the AID key
    
    Returns:
    the AID key
  - setAttentionId
```
public void setAttentionId(java.lang.String value)
```
    set the AID key
    
    Parameters:
    value - the AID key
  - getStartCode
```
public java.lang.String getStartCode()
```
    get the Transaction start code
    
    Returns:
    the Transaction start code
  - setStartCode
```
public void setStartCode(java.lang.String value)
```
    set the Transaction start code
    
    Parameters:
    value - the Transaction start code
  - getCancelCode
```
public java.lang.String getCancelCode()
```
    get the Abend transaction code
    
    Returns:
    the Abend transaction code
  - setCancelCode
```
public void setCancelCode(java.lang.String value)
```
    set the Abend transaction code
    
    Parameters:
    value - the Abend transaction code
  - getNextTransactionId
```
public java.lang.String getNextTransactionId()
```
    get the Next transaction to attach
    
    Returns:
    the Next transaction to attach
  - setNextTransactionId
```
public void setNextTransactionId(java.lang.String value)
```
    set the Next transaction to attach
    
    Parameters:
    value - the Next transaction to attach
  - getCursorPosition
```
public int getCursorPosition()
```
    get the Cursor position
    
    Returns:
    the Cursor position
  - setCursorPosition
```
public void setCursorPosition(int value)
```
    set the Cursor position
    
    Parameters:
    value - the Cursor position
  - getErrorOffset
```
public int getErrorOffset()
```
    get the Offset of error in message
    
    Returns:
    the Offset of error in message
  - setErrorOffset
```
public void setErrorOffset(int value)
```
    set the Offset of error in message
    
    Parameters:
    value -
  - getInputItem
```
public int getInputItem()
```
    get the value of the InputItem field
    
    Returns:
    the value of the InputItem field
  - setInputItem
```
public void setInputItem(int value)
```
    set the value of the InputItem field
    
    Parameters:
    value - the value of the InputItem field
  - nextEncoding
```
public int nextEncoding()
```
    Specified by:
    
    nextEncoding in interface MQChainable
    
    Returns:
    the numeric encoding of the next header or message content.
    See Also:
    MQChainable.nextEncoding()
  - nextEncoding
```
public void nextEncoding(int value)
```
    Description copied from interface: MQChainable
    
    Sets the numeric encoding of the next header or message content.
    
    Specified by:
    
    nextEncoding in interface MQChainable
    
    See Also:
    MQChainable.nextEncoding(int)
  - nextCharacterSet
```
public int nextCharacterSet()
```
    Specified by:
    
    nextCharacterSet in interface MQChainable
    
    Returns:
    the CCSID of the next header or message content.
    See Also:
    MQChainable.nextCharacterSet()
  - nextCharacterSet
```
public void nextCharacterSet(int value)
```
    Description copied from interface: MQChainable
    
    Sets the CCSID of the next header or message content.
    
    Specified by:
    
    nextCharacterSet in interface MQChainable
    
    See Also:
    MQChainable.nextCharacterSet(int)
  - nextFormat
```
public java.lang.String nextFormat()
```
    Specified by:
    
    nextFormat in interface MQChainable
    
    Returns:
    the format of the next header or message content.
    See Also:
    MQChainable.nextFormat()
  - nextFormat
```
public void nextFormat(java.lang.String value)
```
    Description copied from interface: MQChainable
    
    Sets the format of the next header or message content.
    
    Specified by:
    
    nextFormat in interface MQChainable
    
    See Also:
    MQChainable.nextFormat(java.lang.String)
  - format
```
public java.lang.String format()
```
    Specified by:
    
    format in interface MQChainable
    
    Returns:
    the format associated with this header object or message content.
    See Also:
    MQChainable.format()

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

Fields inherited from class com.ibm.mq.headers.internal.Header

Fields inherited from class com.ibm.mq.jmqi.JmqiObject

Methods inherited from class com.ibm.mq.headers.internal.Header

Methods inherited from class java.lang.Object

MQCIH

MQCIH

MQCIH

getStrucId

getVersion

setVersion

getStrucLength

getEncoding

setEncoding

getCodedCharSetId

setCodedCharSetId

getFormat

setFormat

getFlags

setFlags

getReturnCode

setReturnCode

getCompCode

setCompCode

getReason

setReason

getUOWControl

setUOWControl

getGetWaitInterval

setGetWaitInterval

getLinkType

setLinkType

getOutputDataLength

setOutputDataLength

getFacilityKeepTime

setFacilityKeepTime

getADSDescriptor

setADSDescriptor

getConversationalTask

setConversationalTask

getTaskEndStatus

setTaskEndStatus

getFacility

setFacility

getFunction

setFunction

getAbendCode

setAbendCode

getAuthenticator

setAuthenticator

getReplyToFormat

setReplyToFormat

getRemoteSysId

setRemoteSysId

getRemoteTransId

setRemoteTransId

getTransactionId

setTransactionId

getFacilityLike

setFacilityLike

getAttentionId

setAttentionId

getStartCode

setStartCode

getCancelCode

setCancelCode

getNextTransactionId

setNextTransactionId

getCursorPosition

setCursorPosition

getErrorOffset

setErrorOffset

getInputItem

setInputItem

nextEncoding

nextEncoding

nextCharacterSet

nextCharacterSet

nextFormat

nextFormat