com.ibm.ims.dli

Interface GPCB

public interface GPCB

The GPCB interface 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.

Method Summary

Modifier and Type	Method and Description
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.
RSA	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
java.lang.String	getStatusCodeChars() Returns the IMS status code of the last DL/I call as a character string.
int	getUndefinedLengthRecordLength() Returns the length of the undefined-length record after GSAM GU or GN call.

Method Detail

getDBName

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.

getKeyFeedback

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

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.

getProcessOptions

java.lang.String getProcessOptions()

Returns the IMS processing options in this GSAMPCB.

Returns:

The GSAMPCB's IMS processing options.

getRSA

RSA 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).

getStatusCode

short getStatusCode()

Returns the status code of the last GSAM database call using this GSAMPCB

Returns:

The GSAMPCB's status code.

getStatusCodeChars

java.lang.String getStatusCodeChars()

Returns the IMS status code of the last DL/I call as a character string.

Returns:

the status code.

getUndefinedLengthRecordLength

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.