com.ibm.ims.dli

Interface GSAMPCB

public interface GSAMPCB

Object that represents a connection to a GSAM PCB.

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection to a GSAM dataset.
AIB	getAIB() Retrieves the application interface block (AIB) object for the GSAM PCB.
Path	getNext() Retrieves a record in a GSAM database using sequential access.
void	getNext(java.nio.ByteBuffer output) Retrieves a record in a GSAM database using sequential access.
Path	getPathForInsert() Retrieves a Path that contains the GSAM record used for an insert operation.
Path	getUnique(RSA recordSearchArg) Retrieves a record in a GSAM database using random access.
void	getUnique(RSA recordSearchArg, java.nio.ByteBuffer outputBuffer) Retrieves a record in a GSAM database using random access.
RSA	insert(java.nio.ByteBuffer gsamRecordBuffer) Inserts a new record into a GSAM database.
RSA	insert(Path gsamRecord) Inserts a new record into a GSAM database.
void	open() Opens a connection to a GSAM dataset.

Method Detail

open

void open()

Opens a connection to a GSAM dataset.

close

void close()

Close the connection to a GSAM dataset.

Throws:

DLIException - if an error occurs while closing the GSAM dataset.

getUnique

Path getUnique(RSA recordSearchArg)
        throws DLIException

Retrieves a record in a GSAM database using random access.

Parameters:

recordSearchArg - the record search argument (RSA) object that contains the address of a unique GSAM database record.

Returns:

a Path object that contains the GSAM database record data or null if no records are found

Throws:

DLIException - if a GSAM database error occurs.

getUnique

void getUnique(RSA recordSearchArg,
               java.nio.ByteBuffer outputBuffer)
        throws DLIException

Retrieves a record in a GSAM database using random access.

Parameters:

recordSearchArg - the record search argument (RSA) object that contains the address of a unique GSAM database record.

outputBuffer - The output buffer (ByteBuffer) object that will contain the GSAM database record.

Throws:

DLIException - if a GSAM database error occurs.

getNext

Path getNext()
      throws DLIException

Retrieves a record in a GSAM database using sequential access. After calling getNext, the cursor moves to the next record in the database.

Returns:

the Path object that contains the GSAM database record data or null if no records are found

Throws:

DLIException - if a GSAM database error occurs.

getNext

void getNext(java.nio.ByteBuffer output)
      throws DLIException

Retrieves a record in a GSAM database using sequential access. After calling getNext, the cursor moves to the next record in the database.

Parameters:

recordSearchArg - the record search argument (RSA) object that contains the address of a unique GSAM database record.

outputBuffer - The output buffer (ByteBuffer) object that will contain the GSAM database record.

Throws:

DLIException - if a GSAM database error occurs.

insert

RSA insert(Path gsamRecord)
    throws DLIException

Inserts a new record into a GSAM database. New records are appended to the end of the database.

Parameters:

gsamRecord - the Path object that contains the GSAM database record data to be inserted.

Throws:

DLIException - if a GSAM database error occurs.

insert

RSA insert(java.nio.ByteBuffer gsamRecordBuffer)
    throws DLIException

Inserts a new record into a GSAM database. New records are appended to the end of the database.

Parameters:

gsamRecordBuffer - The input buffer (ByteBuffer) object contains the GSAM database record data to be inserted. The ByteBuffer limit will determine the maximum number of bytes to be inserted.

Throws:

DLIException - if a GSAM database error occurs.

getAIB

AIB getAIB()

Retrieves the application interface block (AIB) object for the GSAM PCB.

Returns:

the Application Interface Block (AIB).

getPathForInsert

Path getPathForInsert()

Retrieves a Path that contains the GSAM record used for an insert operation. Use this method together with the insert(Path) method to insert new records in the GSAM database.

Returns:

a Path object that contains the GSAM database record specified as input

See Also:

insert(Path)