com.ibm.ims.base
Class GSAMPCB

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

public final class GSAMPCB
extends java.lang.Object

The GSAMPCB class contains all the data attributes of the GSAM Database Program Communication Block and the necessary getter and setter methods. IMS describes the results of the GSAM database 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 GSAMPCB.
 byte[] getKeyFeedback()
          Returns the concatenated key in this GSAMPCB from the last DLI call using this GSAMPCB.
 int getKeyFeedbackLength()
          Returns the concatenated key length in this GSAMPCB from the last DLI call using this GSAMPCB.
 java.lang.String getProcessOptions()
          Returns the IMS processing options in this GSAMPCB.
 byte[] getRSA()
          Returns the record search argument (RSA) from GSAM DB PCB.
 short getStatusCode()
          Returns the status code of the last GSAM database call using this GSAMPCB
 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 GSAMPCB. The maximum length of this field is 8 characters.
Returns:
The GSAMPCB's database name.

getStatusCode

public short getStatusCode()
Returns the status code of the last GSAM database call using this GSAMPCB
Returns:
The GSAMPCB's status code.

getProcessOptions

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

getKeyFeedback

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

getKeyFeedbackLength

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

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.