com.ibm.ims.dli

Interface INQYCallResult

All Superinterfaces:

DLICallResult

public interface INQYCallResult
extends DLICallResult

Object that represents the output from an Inquiry (INQY) call.

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

Method Summary

Modifier and Type	Method and Description
Vector<DBPCB>	getDBPCBs() Retrieves the DBPCB objects corresponding to all the database PCBs in the PSB.
EnvironInfo	getEnvironInfo() Retrieves information regarding the current execution environment, after an INQY call is issued with the ENVIRON subfunction.
IOPCB	getIOPCB() Retrieves the IOPCB object corresponding to the IMS IOPCB.
MessageInfo	getMessageInfo() Retrieves information regarding the current input message, after an INQY call is issued with the MSGINFO subfunction.
String	getProgramName() Retrieves the application program name, after an INQY call is issued with the PROGRAM subfunction.
String	getSubfunction() Retrieves the subfunction code used in the INQY call.

Methods inherited from interface com.ibm.ims.dli.DLICallResult

getAIB, getDLICallFunction

Method Detail

getDBPCBs

Vector<DBPCB> getDBPCBs()
                 throws DLIException

Retrieves the DBPCB objects corresponding to all the database PCBs in the PSB.

Returns:

the DBPCB objects.

Throws:

DLIException - if unable to get the DB PCB information

getIOPCB

IOPCB getIOPCB()

Retrieves the IOPCB object corresponding to the IMS IOPCB.

Returns:

the IOPCB object.

getSubfunction

String getSubfunction()

Retrieves the subfunction code used in the INQY call.

Returns:

the subfunction code.

getEnvironInfo

EnvironInfo getEnvironInfo()
                    throws DLIException

Retrieves information regarding the current execution environment, after an INQY call is issued with the ENVIRON subfunction.

Returns:

the EnvironInfo object containing the call output.

Throws:

DLIException - if EBCDIC encoding (Cp1047) is not supported

See Also:

EnvironInfo

getMessageInfo

MessageInfo getMessageInfo()
                    throws DLIException

Retrieves information regarding the current input message, after an INQY call is issued with the MSGINFO subfunction.

Returns:

the MessageInfo object containing the call output.

Throws:

DLIException - if EBCDIC encoding (Cp1047) is not supported

See Also:

MessageInfo

getProgramName

String getProgramName()
               throws DLIException

Retrieves the application program name, after an INQY call is issued with the PROGRAM subfunction.

Returns:

the application program name.

Throws:

DLIException - if EBCDIC encoding (Cp1047) is not supported