com.ibm.ims.dli

Interface AIB

public interface AIB

The AIB contains all the data attributes of the IMS application interface block. The AIB contains useful information returned by IMS after every DL/I call.

If the most recent DL/I call is a database call, the getDBPCB() method returns the DBPCB object for that call and the getIOPCB() method returns null.

If the most recent DL/I call is an IMS message queue call, the getIOPCB() method returns the IOPCB object for that call and the getDBPCB() method returns null.

See Also:

DBPCB

Method Summary

Modifier and Type	Method and Description
DBPCB	getDBPCB() Gets the DB PCB (database PCB) referenced by this AIB
int	getErrorCodeExtension() Gets the error code extension produced by the last DLI call through this AIB.
GPCB	getGPCB() Gets the GSAM PCB (GSAM database PCB) referenced by this AIB
IOPCB	getIOPCB() Gets the IO PCB referenced by this AIB
int	getOALength() Gets the maximum output area length in this AIB.
int	getOAUse() Gets the output area length used in this AIB.
int	getReasonCode() Gets the reason code produced by the last DLI call using this AIB.
java.lang.String	getReasonCodeHex() Gets the reason code produced by the last DLI call using this AIB as a hexadecimal string.
int	getResourceAddress1() Gets the Resource Address 1 produced by the last DLI call using this AIB.
java.lang.String	getResourceName() Gets the resource name (PCB name) in this AIB.
java.lang.String	getResourceName2() Gets the four-character ID of ODBA startup table DFSxxxx0, where xxxx is the four-character ID.
int	getReturnCode() Gets the return code produced by the last DLI call using this AIB.
java.lang.String	getReturnCodeHex() Gets the return code produced by the last DLI call using this AIB as a hexadecimal string.
java.lang.String	getSubFunctionCode() Gets the subfunction code in the AIB
void	setOALength(int maxLength) Sets the maximum output area length in this AIB.
void	setResourceName(java.lang.String resourceName) Sets the resource name (PCB name) in this AIB.
void	setResourceName2(java.lang.String resourceName) Sets the four-character ID of ODBA startup table DFSxxxx0, where xxxx is the four-character ID.
void	setSubFunctionCode(java.lang.String subFunctionCode) Sets the subfunction code in this AIB.

Method Detail

getSubFunctionCode

java.lang.String getSubFunctionCode()

Gets the subfunction code in the AIB

Returns:

the subfunction code

setSubFunctionCode

void setSubFunctionCode(java.lang.String subFunctionCode)

Sets the subfunction code in this AIB. This parameter should be a maximum of eight characters. If greater, it will be truncated to eight characters.

Parameters:

subFunctionCode - the subfunction code.

getResourceName

java.lang.String getResourceName()

Gets the resource name (PCB name) in this AIB.

Returns:

the resource name.

setResourceName

void setResourceName(java.lang.String resourceName)

Sets the resource name (PCB name) in this AIB. This parameter should be a maximum of eight characters. If greater, it will be truncated to eight characters.

Parameters:

resourceName - the resource name.

getResourceName2

java.lang.String getResourceName2()

Gets the four-character ID of ODBA startup table DFSxxxx0, where xxxx is the four-character ID.

Returns:

the four-character ID

setResourceName2

void setResourceName2(java.lang.String resourceName)

Sets the four-character ID of ODBA startup table DFSxxxx0, where xxxx is the four-character ID. If a parameter value of less than four characters is given, it will be blank padded.

Parameters:

resourceName - the four-character ID

getOALength

int getOALength()

Gets the maximum output area length in this AIB.

Returns:

the output area length used.

setOALength

void setOALength(int maxLength)

Sets the maximum output area length in this AIB.

Parameters:

maxLength - the maximum output area length

getOAUse

int getOAUse()

Gets the output area length used in this AIB.

Returns:

the output area length used.

getReturnCode

int getReturnCode()

Gets the return code produced by the last DLI call using this AIB.

Returns:

the return code of the last DLI call

getReturnCodeHex

java.lang.String getReturnCodeHex()

Gets the return code produced by the last DLI call using this AIB as a hexadecimal string.

Returns:

the return code of the last DLI call

getReasonCode

int getReasonCode()

Gets the reason code produced by the last DLI call using this AIB.

Returns:

the reason code of the last DLI call.

getReasonCodeHex

java.lang.String getReasonCodeHex()

Gets the reason code produced by the last DLI call using this AIB as a hexadecimal string.

Returns:

the reason code of the last DLI call

getErrorCodeExtension

int getErrorCodeExtension()

Gets the error code extension produced by the last DLI call through this AIB.

Returns:

the error code extension of the last DLI call

getDBPCB

DBPCB getDBPCB()

Gets the DB PCB (database PCB) referenced by this AIB

Returns:

the DBPCB

getIOPCB

IOPCB getIOPCB()

Gets the IO PCB referenced by this AIB

Returns:

the IOPCB object

getGPCB

GPCB getGPCB()

Gets the GSAM PCB (GSAM database PCB) referenced by this AIB

Returns:

the GPCB

getResourceAddress1

int getResourceAddress1()

Gets the Resource Address 1 produced by the last DLI call using this AIB.

Returns:

the Resource Address 1 in the AIB.