com.ibm.ims.dli

Class MessageInfo

java.lang.Object

com.ibm.ims.dli.MessageInfo

public class MessageInfo
extends java.lang.Object

Object that represents the output from an Inquiry (INQY) call that is issued with the MSGINFO subfunction.

For more details about the values returned by the MessageInfo methods, see the topic INQY call in the IMS Application Programming APIs reference documentation.

Constructor Summary

Constructors

Constructor and Description
MessageInfo(byte[] ioArea, com.ibm.ims.dli.t2.INQYCallImpl inqyCallImpl)
MessageInfo(byte[] ioArea, long ioBufferAddress) MessageInfo constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIMSID() Retrieves the IMS identifier from which the input message originated.
int	getReasonCode() Gets the reason code produced by the MSGINFO INQY DLI call.
java.lang.String	getReasonCodeHex() Gets the reason code produced by the MSGINFO INQY DLI call as a hexadecimal string.
int	getReturnCode() Gets the return code produced by the MSGINFO INQY DLI call.
java.lang.String	getReturnCodeHex() Gets the return code produced by the MSGINFO INQY DLI call as a hexadecimal string.
java.lang.String	getSessionID() Retrieves the distributed network session ID.
int	getStatusCode() Gets the IMS status code of the INQY call from the IOPCB.
java.lang.String	getStatusCodeChars() Gets the IMS status code of the INQY call from the IOPCB as a character string.
java.lang.String	getUserID() Retrieves the distributed network user ID.
java.lang.String	getVersionNumber() Retrieves the output response version.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageInfo

public MessageInfo(byte[] ioArea,
                   long ioBufferAddress)
            throws java.io.UnsupportedEncodingException

MessageInfo constructor.

Parameters:

ioArea - a byte array that represents the data output area.

Throws:

java.io.UnsupportedEncodingException

MessageInfo

public MessageInfo(byte[] ioArea,
                   com.ibm.ims.dli.t2.INQYCallImpl inqyCallImpl)
            throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

Method Detail

getVersionNumber

public java.lang.String getVersionNumber()

Retrieves the output response version.

Returns:

the version number

getIMSID

public java.lang.String getIMSID()

Retrieves the IMS identifier from which the input message originated.

Returns:

IMS identifier.

getUserID

public java.lang.String getUserID()
                           throws DLIException

Retrieves the distributed network user ID.

Returns:

user ID address

Throws:

DLIException

getSessionID

public java.lang.String getSessionID()
                              throws DLIException

Retrieves the distributed network session ID.

Returns:

session ID

Throws:

DLIException

getReasonCode

public int getReasonCode()

Gets the reason code produced by the MSGINFO INQY DLI call.

Returns:

the reason code of the INQY DLI call

getReasonCodeHex

public java.lang.String getReasonCodeHex()

Gets the reason code produced by the MSGINFO INQY DLI call as a hexadecimal string.

Returns:

the reason code of the INQY DLI call

getReturnCode

public int getReturnCode()

Gets the return code produced by the MSGINFO INQY DLI call.

Returns:

the return code of the INQY DLI call

getReturnCodeHex

public java.lang.String getReturnCodeHex()

Gets the return code produced by the MSGINFO INQY DLI call as a hexadecimal string.

Returns:

the return code of the INQY DLI call

getStatusCode

public int getStatusCode()

Gets the IMS status code of the INQY call from the IOPCB.

Returns:

the IMS status code of the INQY DLI call.

getStatusCodeChars

public java.lang.String getStatusCodeChars()

Gets the IMS status code of the INQY call from the IOPCB as a character string.

Returns:

the IMS status code of the INQY DLI call.