com.ibm.ims.db
Class GSAMConnection

java.lang.Object
  |
  +--com.ibm.ims.db.GSAMConnection

public class GSAMConnection
extends java.lang.Object


Method Summary
 void closeForRead(java.lang.String actualGSAMPCBName)
          This method is used to close a GSAM PCB which was opened for READ ONLY.
 void closeForWrite(java.lang.String actualGSAMPCBName)
          This method is used to close a GSAM PCB which was opened for LOAD ONLY.
static GSAMConnection createInstance()
          Creates a GSAMConnection instance
 boolean getNext(java.lang.String actualGSAMPCBName, GSAMRecord gsamRecord)
          This method is used to sequentially access GSAM records in a GSAM database.
 boolean getNext(java.lang.String actualGSAMPCBName, GSAMRecord gsamRecord, RSA rsa)
          This method is used to sequentially access GSAM records in a GSAM database.
 boolean getUnique(java.lang.String actualGSAMPCBName, GSAMRecord gsamRecord, RSA rsa)
          This method is used to randomly access a GSAM record in a GSAM database.
 void insert(java.lang.String actualGSAMPCBName, GSAMRecord gsamRecord)
          This method is used to insert a new GSAM record into a GSAM database.
 void insert(java.lang.String actualGSAMPCBName, GSAMRecord gsamRecord, RSA rsa)
          This method is used to insert a new GSAM record into a GSAM database.
 void openForRead(java.lang.String actualGSAMPCBName)
          This method is used to open a GSAM PCB for READ ONLY.
 void openForWrite(java.lang.String actualGSAMPCBName)
          This method is used to open a GSAM PCB for LOAD ONLY.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createInstance

public static GSAMConnection createInstance()
Creates a GSAMConnection instance
Returns:
 

openForRead

public void openForRead(java.lang.String actualGSAMPCBName)
                 throws IMSException
This method is used to open a GSAM PCB for READ ONLY. This method is used when using a GSAM PCB which has the processing option as "G", which implies READ_ONLY.
Parameters:
actualGSAMPCBName - The actual GSAM PCB name as defined in the PSB.
Throws:
IMSException -  

openForWrite

public void openForWrite(java.lang.String actualGSAMPCBName)
                  throws IMSException
This method is used to open a GSAM PCB for LOAD ONLY. This method is used when using a GSAM PCB which has the processing option as "L", which implies LOAD_ONLY.
Parameters:
actualGSAMPCBName - The actual GSAM PCB name as defined in the PSB.
Throws:
IMSException -  

closeForRead

public void closeForRead(java.lang.String actualGSAMPCBName)
                  throws IMSException
This method is used to close a GSAM PCB which was opened for READ ONLY. This method is used when using a GSAM PCB which has the processing option as "G", which implies READ ONLY.
Parameters:
actualGSAMPCBName - The actual GSAM PCB name as defined in the PSB.
Throws:
IMSException -  

closeForWrite

public void closeForWrite(java.lang.String actualGSAMPCBName)
                   throws IMSException
This method is used to close a GSAM PCB which was opened for LOAD ONLY. This method is used when using a GSAM PCB which has the processing option as "L", which implies LOAD ONLY.
Parameters:
actualGSAMPCBName - The actual GSAM PCB name as defined in the PSB.
Throws:
IMSException -  

getUnique

public boolean getUnique(java.lang.String actualGSAMPCBName,
                         GSAMRecord gsamRecord,
                         RSA rsa)
                  throws IMSException
This method is used to randomly access a GSAM record in a GSAM database.
Parameters:
actualGSAMPCBName - The actual GSAM PCB name as defined in the PSB
gsamRecord - The GSAMRecord object that will be filled with the GSAM database record data. It is an output parameter.
rsa - The RSA(Record Search Argument) object that contains the address of a unique GSAM database record.
Returns:
true: if the GSAM database record was found false: otherwise
Throws:
IMSException -  

getNext

public boolean getNext(java.lang.String actualGSAMPCBName,
                       GSAMRecord gsamRecord)
                throws IMSException
This method is used to sequentially access GSAM records in a GSAM database. After each getNext(...) call, the cursor moves to the next record in the database.
Parameters:
actualGSAMPCBName - The actual GSAM PCB name as defined in the PSB
gsamRecord - The GSAMRecord object that will be filled with the GSAM database record data. It is an output parameter.
Returns:
true: if a GSAM database record was found false: if reached end of database
Throws:
IMSException -  

getNext

public boolean getNext(java.lang.String actualGSAMPCBName,
                       GSAMRecord gsamRecord,
                       RSA rsa)
                throws IMSException
This method is used to sequentially access GSAM records in a GSAM database. After each getNext(...) call, the cursor moves to the next record in the database.
Parameters:
actualGSAMPCBName - The actual GSAM PCB name as defined in the PSB
gsamRecord - The GSAMRecord object that will be filled with the GSAM database record data. It is an output parameter.
rsa - The RSA(Record Search Argument) object that contains the address of the GSAM database record returned with this call. It is an output parameter.
Returns:
true: if a GSAM database record was found false: if reached end of database
Throws:
IMSException -  

insert

public void insert(java.lang.String actualGSAMPCBName,
                   GSAMRecord gsamRecord)
            throws IMSException
This method is used to insert a new GSAM record into a GSAM database. Records are only appended to the end of the database.
Parameters:
actualGSAMPCBName - The actual GSAM PCB name as defined in the PSB
gsamRecord - The GSAMRecord object that contains the GSAM database record data to be inserted. It is an input parameter.
Returns:
true: if a GSAM database record was found false: if reached end of database
Throws:
IMSException -  

insert

public void insert(java.lang.String actualGSAMPCBName,
                   GSAMRecord gsamRecord,
                   RSA rsa)
            throws IMSException
This method is used to insert a new GSAM record into a GSAM database. Records are only appended to the end of the database.
Parameters:
actualGSAMPCBName - The actual GSAM PCB name as defined in the PSB
gsamRecord - The GSAMRecord object that contains the GSAM database record data to be inserted. It is an input parameter.
rsa - The RSA(Record Search Argument) object that contains the address of a unique GSAM database record.
Returns:
true: if a GSAM database record was found false: if reached end of database
Throws:
IMSException -  


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