com.ibm.ims.base
Class DBPCB

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

public final class DBPCB
extends java.lang.Object

The DBPCB class contains all the data attributes of the IMS Database Program Program Communication Block and the necessary getter and setter methods. IMS describes the results of the calls your program issues in the DB PCB that is referenced in the call. For more information, see IMS Application Programming: Database Manager.


Method Summary
 java.lang.String getDBName()
          Returns the database name in this DBPCB.
 byte[] getKeyFeedback()
          Returns the concatenated key in this DBPCB from the last DLI call using this DBPCB.
 int getKeyFeedbackLength()
          Returns the concatenated key length in this DBPCB from the last DLI call using this DBPCB.
 int getNumberSensitiveSegments()
          Returns the number of sensitive segments in this DBPCB from the last DLI call using this DBPCB.
 java.lang.String getProcessOptions()
          Returns the IMS processing options in this DBPCB.
 byte[] getRSA()
          Returns the record search argument (RSA) from GSAM DB PCB.
 int getSegmentLevelNumber()
          Returns the segment level in this DBPCB from the last DLI call using this DBPCB.
 java.lang.String getSegmentName()
          Returns the IMS segment name in this DBPCB from the last DLI call using this DBPCB.
 short getStatusCode()
          Returns the IMS status code of the last DLI call using this .
 int getUndefinedLengthRecordLength()
          Returns the length of the undefined-length record after GSAM GU or GN call.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDBName

public java.lang.String getDBName()
Returns the database name in this DBPCB. The maximum length of this field is 8 characters.
Returns:
The DBPCB's database name.

getStatusCode

public short getStatusCode()
Returns the IMS status code of the last DLI call using this . DBPCB
Returns:
The DBPCB's IMS status code.

getProcessOptions

public java.lang.String getProcessOptions()
Returns the IMS processing options in this DBPCB.
Returns:
The DBPCB's IMS processing options.

getSegmentName

public java.lang.String getSegmentName()
Returns the IMS segment name in this DBPCB from the last DLI call using this DBPCB.
Returns:
The DBPCB's segment name.

getKeyFeedback

public byte[] getKeyFeedback()
Returns the concatenated key in this DBPCB from the last DLI call using this DBPCB. Returns null if no concatenated key returned from IMS.
Returns:
The DBPCB's concatenated key.

getSegmentLevelNumber

public int getSegmentLevelNumber()
Returns the segment level in this DBPCB from the last DLI call using this DBPCB.
Returns:
The DBPCB's segment level.

getKeyFeedbackLength

public int getKeyFeedbackLength()
Returns the concatenated key length in this DBPCB from the last DLI call using this DBPCB.
Returns:
The DBPCB's concatenated key length.

getNumberSensitiveSegments

public int getNumberSensitiveSegments()
Returns the number of sensitive segments in this DBPCB from the last DLI call using this DBPCB.
Returns:
The DBPCB's number of sensitive segments.

getRSA

public byte[] getRSA()
Returns the record search argument (RSA) from GSAM DB PCB. It is 8 bytes long or null if DB PCB is not GSAM. NOTE: if GSAM, the keyFeedback is 12 bytes long. The first 8 bytes is record search argument which can be used later on if you want to retrieve that record directly by including it as one of the parameters on a GU call. The last 4 bytes is the length of the undefined-length record(RECFM=U)
Returns:
GSAM DB PCB record search argument (RSA).

getUndefinedLengthRecordLength

public int getUndefinedLengthRecordLength()
Returns the length of the undefined-length record after GSAM GU or GN call. Return 0 if DB PCB is not GSAM.
Returns:
the length of the undefined-length record.


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