com.ibm.ims.dli

Interface DBPCB

public interface DBPCB

The DBPCB interface contains all the data attributes of the IMS database program communication block from the most recent DL/I call. The DBPCB contains the two character status code returned by IMS after the last DL/I call. The DBPCB object reference is retrieved using the AIB class.

See Also:

AIB

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDBName() Gets the database name.
byte[]	getKeyFeedback() Returns the key feedback area from the last DLI call.
int	getKeyFeedbackLength() Returns the length of the key feedback area.
int	getNumberSensitiveSegments() Returns the number of segment types in the database to which the application program is sensitive.
java.lang.String	getProcessOptions() Returns the IMS processing options (type of calls this program can issue).
int	getSegmentLevelNumber() Returns the segment level number of the lowest-level segment retrieved.
java.lang.String	getSegmentName() Returns the name of the last segment that satisfied the call.
short	getStatusCode() Returns the IMS status code of the last DLI call.
java.lang.String	getStatusCodeChars() Returns the IMS status code of the last DL/I call as a character string.

Method Detail

getDBName

java.lang.String getDBName()

Gets the database name.

Returns:

the database name.

getKeyFeedback

byte[] getKeyFeedback()

Returns the key feedback area from the last DLI call.

At the completion of a retrieval or ISRT call, IMS places the concatenated key of the retrieved segment in this field. A segment's concatenated key is made up of the keys of each of its parents and its own key. Keys are positioned left to right, starting with the key of the root segment and following the hierarchic path.

Returns:

the key feedback area

getKeyFeedbackLength

int getKeyFeedbackLength()

Returns the length of the key feedback area.

Returns:

the length of the key feedback area

getNumberSensitiveSegments

int getNumberSensitiveSegments()

Returns the number of segment types in the database to which the application program is sensitive.

Returns:

the number of sensitive segments

getProcessOptions

java.lang.String getProcessOptions()

Returns the IMS processing options (type of calls this program can issue).

Returns:

the processing options

getSegmentLevelNumber

int getSegmentLevelNumber()

Returns the segment level number of the lowest-level segment retrieved. If IMS is unable to find the segment that you requested, it returns the level number of the last segment it encountered that satisfied your call.

Returns:

the segment level number

getSegmentName

java.lang.String getSegmentName()

Returns the name of the last segment that satisfied the call.

Returns:

the segment name

getStatusCode

short getStatusCode()

Returns the IMS status code of the last DLI call.

Returns:

the status code.

See Also:

IMSStatusCodes

getStatusCodeChars

java.lang.String getStatusCodeChars()

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

Returns:

the status code.