com.ibm.ims.dli

Class MessageInfo

java.lang.Object

com.ibm.ims.dli.MessageInfo

public class MessageInfo
extends 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) MessageInfo constructor.
MessageInfo(byte[] ioArea, com.ibm.ims.dli.t2.INQYCallImpl inqyCallImpl)

Method Summary

Modifier and Type	Method and Description
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.
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.
String	getReturnCodeHex() Gets the return code produced by the MSGINFO INQY DLI call as a hexadecimal string.
int	getStatusCode() Gets the IMS status code of the INQY call from the IOPCB.
String	getStatusCodeChars() Gets the IMS status code of the INQY call from the IOPCB as a character string.
String	getVersionNumber() Retrieves the output response version.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageInfo

public MessageInfo(byte[] ioArea)
            throws UnsupportedEncodingException

MessageInfo constructor.

Parameters:

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

Throws:

UnsupportedEncodingException

MessageInfo

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

Throws:

UnsupportedEncodingException

Method Detail

getVersionNumber

public String getVersionNumber()

Retrieves the output response version.

Returns:

the version number

getIMSID

public String getIMSID()

Retrieves the IMS identifier from which the input message originated.

Returns:

IMS identifier.

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 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 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 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.