com.ibm.ims.base
Class AIB

java.lang.Object
  |
  +--com.ibm.ims.base.AIB

public final class AIB
extends java.lang.Object

The Application Interface Block (AIB) is used by your program to communicate with IMS. The AIB class contains all the data attributes of the IMS Application Interface Block and the necessary getter and setter methods. It contains an IOPCB object, an alternate PCB object, and a DBPCB object. It also contains a boolean variable indicating if the IOPCB object references an alternate PCB. See IMS Application Programming: Database Manager.

See Also:
IOPCB, AlternatePCB, DBPCB, GSAMPCB

Constructor Summary
AIB()
          Constructs an AIB.
AIB(java.lang.String resourceName, int ioAreaLength)
          Constructs an AIB with a resource name and the I/O area length.
 
Method Summary
 AlternatePCB getAlternatePCB()
          Returns the Alternate PCB object in this AIB.
 DBPCB getDBPCB()
          Returns the DBPCB object in this AIB.
 int getErrorCodeExtension()
          Returns the error code extension produced by the last DLI call through this AIB.
 GSAMPCB getGSAMPCB()
          Returns the DBPCB object in this AIB.
 IOPCB getIOPCB()
          Returns the IOPCB object in this AIB.
 int getOALength()
          Returns the maximum output area length in this AIB.
 int getOAUse()
          Returns the output area length used in this AIB.
 int getReasonCode()
          Returns the reason code produced by the last DLI call through this AIB.
 java.lang.String getReasonCodeHex()
          Returns the reason code produced by the last DLI call through this AIB as a hexadecimal string.
 java.lang.String getResourceName()
          Returns the resource name (PCB name) in this AIB.
 java.lang.String getResourceName2()
           
 int getReturnCode()
          Returns the return code produced by the last DLI call through this AIB.
 java.lang.String getReturnCodeHex()
          Returns the return code produced by the last DLI call through this AIB as a hexadecimal string.
 java.lang.String getSubFunctionCode()
          Returns the subfunction code in this AIB.
 boolean isAlternatePCB()
          Returns true if PCB is an alternate PCB.
 void setAlternatePCB(boolean isAlternate)
          Sets an indicator designating whether the PCB is an alternate PCB
 void setGSAMFlag(boolean isGSAM)
           
 void setOALength(int length)
          Sets the maximum output area length in this AIB.
 void setResourceName(java.lang.String resourceName)
          Sets the resource name (usually PCB name) in this AIB.
 void setResourceName2(java.lang.String resourceName)
          Sets the resource name (usually PCB name) in this AIB.
 void setSubFunctionCode(java.lang.String subFunctionCode)
          Sets the subfunction code in this AIB.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AIB

public AIB(java.lang.String resourceName,
           int ioAreaLength)
Constructs an AIB with a resource name and the I/O area length.
Parameters:
resourceName - A PCB name. This parameter should be a maximum of 8 characters, if greater, will be truncated to 8 characters.
ioAreaLength - The length of the I/O area.

AIB

public AIB()
Constructs an AIB. Resource name and I/O area length must be set before use.
Method Detail

setAlternatePCB

public void setAlternatePCB(boolean isAlternate)
Sets an indicator designating whether the PCB is an alternate PCB
Parameters:
isAlternate - true if PCB is alternate.

isAlternatePCB

public boolean isAlternatePCB()
Returns true if PCB is an alternate PCB.
Returns:
true if PCB is alternate or false if PCB is not alternate.

getSubFunctionCode

public java.lang.String getSubFunctionCode()
Returns the subfunction code in this AIB.
Returns:
The AIB's subfunction code.

setSubFunctionCode

public void setSubFunctionCode(java.lang.String subFunctionCode)
Sets the subfunction code in this AIB. This parameter should be a maximum of 8 characters, if greater, will be truncated to 8 characters.
Parameters:
subFunctionCode - The AIB's subfunction code.

getResourceName

public java.lang.String getResourceName()
Returns the resource name (PCB name) in this AIB.
Returns:
The AIB's resource name.

setResourceName

public void setResourceName(java.lang.String resourceName)
Sets the resource name (usually PCB name) in this AIB. This parameter should be a maximum of 8 characters, if greater, will be truncated to 8 characters.
Parameters:
resourceName - The AIB's resource name.

getResourceName2

public java.lang.String getResourceName2()

setResourceName2

public void setResourceName2(java.lang.String resourceName)
Sets the resource name (usually PCB name) in this AIB. This parameter should be a maximum of 8 characters, if greater, will be truncated to 8 characters.
Parameters:
resourceName - The AIB's resource name.

getOALength

public int getOALength()
Returns the maximum output area length in this AIB.
Returns:
The output area length used.

setOALength

public void setOALength(int length)
Sets the maximum output area length in this AIB.
Parameters:
length - The output area length used.

getOAUse

public int getOAUse()
Returns the output area length used in this AIB.
Returns:
The output area length used.

getReturnCode

public int getReturnCode()
Returns the return code produced by the last DLI call through this AIB.
Returns:
The return code of the last DLI call.

getReturnCodeHex

public java.lang.String getReturnCodeHex()
Returns the return code produced by the last DLI call through this AIB as a hexadecimal string.
Returns:
The return code of the last DLI call.

getReasonCode

public int getReasonCode()
Returns the reason code produced by the last DLI call through this AIB.
Returns:
The reason code of the last DLI call.

getReasonCodeHex

public java.lang.String getReasonCodeHex()
Returns the reason code produced by the last DLI call through this AIB as a hexadecimal string.
Returns:
The reason code of the last DLI call.

getErrorCodeExtension

public int getErrorCodeExtension()
Returns the error code extension produced by the last DLI call through this AIB.
Returns:
The error code extension of the last DLI call.

getGSAMPCB

public GSAMPCB getGSAMPCB()
Returns the DBPCB object in this AIB.
Returns:
The DBPCB in thsi AIB.

getDBPCB

public DBPCB getDBPCB()
Returns the DBPCB object in this AIB.
Returns:
The DBPCB in thsi AIB.

getIOPCB

public IOPCB getIOPCB()
Returns the IOPCB object in this AIB.
Returns:
The IOPCB in this AIB.

getAlternatePCB

public AlternatePCB getAlternatePCB()
Returns the Alternate PCB object in this AIB.
Returns:
The Alternate PCB in this AIB.

setGSAMFlag

public void setGSAMFlag(boolean isGSAM)


(C) International Business Machines Corporation 2004. All rights reserved.