com.ibm.dse.services.appltables
Interface ApplicationTablesService

All Known Implementing Classes:
ApplicationTables

public interface ApplicationTablesService

Defines the methods that an application using a static data tables service may call to access the table information. A service providing this interface must implement these methods.


Method Summary
 boolean checkForTableInDatabase(java.lang.String aTableName)
          Returns true if the table exists in memory or false if it does not.
 void connect(java.lang.String aDatabaseURL, java.lang.String aUser, java.lang.String aPassword)
          Establishes a database connection
 void disconnect()
          Closes the connection to the database.
 Vector getAllRecords(java.lang.String aTableName)
          Gets all columns of all the records in the table specified by aTableName.
 void getAllRecords(java.lang.String aTableName, HashtableIndexedCollectionFormat aHashtableICollFormat, Context aContext)
          Gets all columns of all records in table aTableName.
 void getAllRecords(java.lang.String aTableName, HashtableIndexedCollectionFormat aHashtableICollFormat, Context aContext, Vector vectorOfColumns)
          Gets all columns of all records in table aTableName.
 void getAllRecords(java.lang.String aTableName, java.lang.String aHashtableICollFormatName, Context aContext)
          Gets all columns of all records in table aTableName.
 void getAllRecords(java.lang.String aTableName, java.lang.String aHashtableICollFormatName, Context aContext, Vector vectorOfColumns)
          Gets the columns specified in vectorOfColumns argument of all records in table aTableName.
 Vector getAllRecords(java.lang.String aTableName, Vector vectorOfColumns)
          Gets the columns specified in vectorOfColumns argument of all the records in table specified by aTableName.
 java.lang.String getEnterprise()
          Returns the enterprise information.
 java.sql.Connection getInMemoryConnection()
          Returns the inMemoryConnection attribute value.
 java.lang.String getLanguage()
          Returns the language information.
 Vector getNextRecords(java.lang.String aTableName, int cursorPosition, int numberOfRecords)
          Gets all columns of the next numberOfRecords records from the position set as cursorPosition in table aTableName.
 int getNextRecords(java.lang.String aTableName, int cursorPosition, int numberOfRecords, HashtableIndexedCollectionFormat aHashtableICollFormat, Context aContext)
          Gets all columns of the next numberOfRecords records from the cursor position set as cursorPosition in table aTableName.
 int getNextRecords(java.lang.String aTableName, int cursorPosition, int numberOfRecords, HashtableIndexedCollectionFormat aHashtableICollFormat, Context aContext, Vector vectorOfColumns)
          Gets the columns specified in vectorOfColumns argument of the next numberOfRecords records from the cursor position set as cursorPosition in table aTableName.
 int getNextRecords(java.lang.String aTableName, int cursorPosition, int numberOfRecords, java.lang.String aHashtableICollFormatName, Context aContext)
          Gets all columns of the next numberOfRecords records from the cursor position set as cursorPosition in table aTableName.
 int getNextRecords(java.lang.String aTableName, int cursorPosition, int numberOfRecords, java.lang.String aHashtableICollFormatName, Context aContext, Vector vectorOfColumns)
          Gets the columns specified in vectorOfColumns argument of the next numberOfRecords records from the cursor position set as cursorPosition in table aTableName.
 Vector getNextRecords(java.lang.String aTableName, int cursorPosition, int numberOfRecords, Vector vectorOfColumns)
          Gets the columns specified in vectorOfColumns argument of the next numberOfRecords records from the position set as cursorPosition in table aTableName.
 java.lang.String getPrimaryKey(java.lang.String aTableName)
          Returns the name of the table aTableName column that is primary key.
 Hashtable getRecord(java.lang.String aTableName, java.lang.Object key)
          Gets all columns of the record identified by a key from the table aTableName.
 void getRecord(java.lang.String aTableName, java.lang.Object key, HashtableFormat aHashtableFormat, Context aContext)
          Gets all columns of the record identified by a key from the table aTableName.
 void getRecord(java.lang.String aTableName, java.lang.Object key, HashtableFormat aHashtableFormat, Context aContext, Vector vectorOfColumns)
          Gets the columns specified in vectorOfColumns argument of the record identified by key from the table aTableName.
 void getRecord(java.lang.String aTableName, java.lang.Object key, java.lang.String aHashtableFormatName, Context aContext)
          Gets all columns of the record identified by key from the table aTableName.
 void getRecord(java.lang.String aTableName, java.lang.Object key, java.lang.String aHashtableFormatName, Context aContext, Vector vectorOfColumns)
          Gets the columns specified in vectorOfColumns argument of the record identified by key from the table aTableName.
 Hashtable getRecord(java.lang.String aTableName, java.lang.Object key, Vector vectorOfColumns)
          Gets the columns specified in vectorOfColumns argument of the record identified by a key from the table aTableName.
 Vector getRecords(java.lang.String aTableName, java.lang.Object keyFrom, java.lang.Object keyTo)
          Gets all columns of the records with primary key between keyFrom and keyTo values from the table aTableName.
 void getRecords(java.lang.String aTableName, java.lang.Object keyFrom, java.lang.Object keyTo, HashtableIndexedCollectionFormat aHashtableICollFormat, Context aContext)
          Gets all columns of the records with primary key between keyFrom and keyTo from the table aTableName.
 void getRecords(java.lang.String aTableName, java.lang.Object keyFrom, java.lang.Object keyTo, HashtableIndexedCollectionFormat aHashtableICollFormat, Context aContext, Vector vectorOfColumns)
          Gets the columns specified in vectorOfColumns argument of the records with primary key between keyFrom and keyTo from the table aTableName.
 void getRecords(java.lang.String aTableName, java.lang.Object keyFrom, java.lang.Object keyTo, java.lang.String aHashtableICollFormatName, Context aContext)
          Gets all columns of the records with primary key between keyFrom and keyTo from the table aTableName.
 void getRecords(java.lang.String aTableName, java.lang.Object keyFrom, java.lang.Object keyTo, java.lang.String aHashtableICollFormatName, Context aContext, Vector vectorOfColumns)
          Gets the columns specified in vectorOfColumns argument of the records with primary key between keyFrom and keyTo from the table aTableName.
 Vector getRecords(java.lang.String aTableName, java.lang.Object keyFrom, java.lang.Object keyTo, Vector vectorOfColumns)
          Gets the columns specified in vectorOfColumns argument of the records with primary key between keyFrom and keyTo from the table aTableName.
 Vector getTableNames()
          Returns a Vector with the name of all tables created in the memory database.
 java.lang.Object getTableRecords(java.lang.String aTableName, java.lang.String stOrder, java.lang.String stFilter)
          Returns an Object containing all the records in the table aTable name matching the stFilter search condition and ordered as set in the stOrder argument.
 java.lang.Object getTableRecords(java.lang.String aTableName, java.lang.String stOrder, java.lang.String stFilter, Vector vectorOfColumns)
          Returns an Object containing all records in the table aTable name matching the stFilter search condition and ordered as set in the stOrder argument.
 Hashtable manageRecord(java.lang.String aTableName, java.lang.Object records)
          Returns a Hashtable containing the data of the record retrieved by executing the getTableRecords() method.
 Vector manageRecords(java.lang.String aTableName, int cursorPosition, int numberOfRecords, java.lang.Object records)
          Returns a Vector of Hashtables.
 Vector manageRecords(java.lang.String aTableName, java.lang.Object records)
          Returns a Vector of Hashtables.
 

Method Detail

checkForTableInDatabase

public boolean checkForTableInDatabase(java.lang.String aTableName)
                                throws DSESQLException
Returns true if the table exists in memory or false if it does not.
Parameters:
aTableName - java.lang.String
Returns:
boolean
Throws:
DSESQLException - if an SQLException occurs

connect

public void connect(java.lang.String aDatabaseURL,
                    java.lang.String aUser,
                    java.lang.String aPassword)
             throws DSESQLException
Establishes a database connection
Parameters:
aDatabaseURL - java.lang.String, the database URL
aUser - java.lang.String, the user identification to connect to the database
aPassword - java.lang.String, the user password to connect to the database
Throws:
DSESQLException - if an SQLException occurs

disconnect

public void disconnect()
                throws DSESQLException
Closes the connection to the database.
Throws:
DSESQLException - if an SQLException occurs

getAllRecords

public Vector getAllRecords(java.lang.String aTableName)
                     throws DSEInvalidArgumentException,
                            DSESQLException,
                            DSEException
Gets all columns of all the records in the table specified by aTableName. A Vector of Hashtables will be returned. Each Hashtable contains the data for one record. The Hashtable key is the column name and the Hashtable value is the column data
Parameters:
aTableName - String, the name of the table
vectorOfColumnsValues - Vector, vector with the values of the records columns
Returns:
com.ibm.dse.base.Vector - a Vector of as many Hashtables as records in the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation

getAllRecords

public void getAllRecords(java.lang.String aTableName,
                          HashtableIndexedCollectionFormat aHashtableICollFormat,
                          Context aContext)
                   throws DSEInvalidArgumentException,
                          DSESQLException,
                          DSEException,
                          java.io.IOException
Gets all columns of all records in table aTableName. The context aContext is then updated with the result of the query by the using the formatter named aHashtableICollFormatName. The formatter will convert the Vector of Hashtables into a IndexedCollection of KeyedCollections.
Parameters:
aTableName - String, the name of the table
aHashtableICollFormat - HashtableIndexedCollectionFormat, the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getAllRecords

public void getAllRecords(java.lang.String aTableName,
                          HashtableIndexedCollectionFormat aHashtableICollFormat,
                          Context aContext,
                          Vector vectorOfColumns)
                   throws DSEInvalidArgumentException,
                          DSESQLException,
                          DSEException,
                          java.io.IOException
Gets all columns of all records in table aTableName. The context aContext is then updated with the result of the query by the using the formatter named aHashtableICollFormatName. The formatter will convert the Vector of Hashtables into a IndexedCollection of KeyedCollections.
Parameters:
aTableName - String, the name of the table
aHashtableICollFormat - HashtableIndexedCollectionFormat, the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getAllRecords

public Vector getAllRecords(java.lang.String aTableName,
                            Vector vectorOfColumns)
                     throws DSEInvalidArgumentException,
                            DSESQLException,
                            DSEException
Gets the columns specified in vectorOfColumns argument of all the records in table specified by aTableName. A Vector of Hashtables will be returned. Each Hashtable contains the data for one record. The Hashtable key is the column name and the Hashtable value is the column data
Parameters:
aTableName - String, the name of the table
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Returns:
com.ibm.dse.base.Vector - a Vector of as many Hashtables as records in the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation

getAllRecords

public void getAllRecords(java.lang.String aTableName,
                          java.lang.String aHashtableICollFormatName,
                          Context aContext)
                   throws DSEInvalidArgumentException,
                          DSESQLException,
                          DSEException,
                          java.io.IOException
Gets all columns of all records in table aTableName. The context aContext is then updated with the result of the query by the using the formatter named aHashtableICollFormatName. The formatter will convert the Vector of Hashtables into a IndexedCollection of KeyedCollections.
Parameters:
aTableName - String, the name of the table
aHashtableICollFormatName - String, the name of the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getAllRecords

public void getAllRecords(java.lang.String aTableName,
                          java.lang.String aHashtableICollFormatName,
                          Context aContext,
                          Vector vectorOfColumns)
                   throws DSEInvalidArgumentException,
                          DSESQLException,
                          DSEException,
                          java.io.IOException
Gets the columns specified in vectorOfColumns argument of all records in table aTableName. The context aContext is then updated with the result of the query by the using the formatter named aHashtableICollFormatName. The formatter will convert the Vector of Hashtables into a IndexedCollection of KeyedCollections.
Parameters:
aTableName - String, the name of the table
aHashtableICollFormatName - String, the name of the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getEnterprise

public java.lang.String getEnterprise()
Returns the enterprise information.
Returns:
java.lang.String

getInMemoryConnection

public java.sql.Connection getInMemoryConnection()
Returns the inMemoryConnection attribute value.
Returns:
java.sql.Connection

getLanguage

public java.lang.String getLanguage()
Returns the language information.
Returns:
java.lang.String

getNextRecords

public Vector getNextRecords(java.lang.String aTableName,
                             int cursorPosition,
                             int numberOfRecords)
                      throws DSESQLException,
                             DSEInvalidArgumentException,
                             DSEException
Gets all columns of the next numberOfRecords records from the position set as cursorPosition in table aTableName. A Vector of Hashtables will be returned. Each Hashtable contains the data for one record. The Hashtable key is the column name and the Hashtable value is the column data. If the number of remaining records in the table from the current cursor is less that number of records, only these records will be returned; if the cursor is already positioned after the last record, an empty vector will be returned.
Parameters:
aTableName - String, the name of the table
cursorPosition - int, the cursor position to start retrieving the records from
numberOfRecords - int, number of records to be retrieved
Returns:
com.ibm.dse.base.Vector - a Vector of as many Hashtables as retrieved records
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation

getNextRecords

public int getNextRecords(java.lang.String aTableName,
                          int cursorPosition,
                          int numberOfRecords,
                          HashtableIndexedCollectionFormat aHashtableICollFormat,
                          Context aContext)
                   throws DSESQLException,
                          DSEInvalidArgumentException,
                          DSEException,
                          java.io.IOException
Gets all columns of the next numberOfRecords records from the cursor position set as cursorPosition in table aTableName. A Vector of Hashtables will be returned. Each Hashtable contains the data for one record. The Hashtable key is the column name and the Hashtable value is the column data. The context aContext is then updated with the result of the query by using the formatter aHashtableICollFormat. If the number of remaining records in the table from the current cursor is less that number of records, only these records will be returned and the method will return 0; if the cursor is already positioned after the last record, the method will return -1.
Parameters:
aTableName - String, the name of the table
cursorPosition - int, the cursor position to start retrieving the records from
numberOfRecords - int, number of records to be retrieved
aHashtableICollFormat - HashtableIndexedCollectionFormat, the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
Returns:
int - new cursor position in the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getNextRecords

public int getNextRecords(java.lang.String aTableName,
                          int cursorPosition,
                          int numberOfRecords,
                          HashtableIndexedCollectionFormat aHashtableICollFormat,
                          Context aContext,
                          Vector vectorOfColumns)
                   throws DSESQLException,
                          DSEInvalidArgumentException,
                          DSEException,
                          java.io.IOException
Gets the columns specified in vectorOfColumns argument of the next numberOfRecords records from the cursor position set as cursorPosition in table aTableName. A Vector of Hashtables will be returned. Each Hashtable contains the data for one record. The Hashtable key is the column name and the Hashtable value is the column data. The context aContext is then updated with the result of the query by using the formatter aHashtableICollFormat. If the number of remaining records in the table from the current cursor is less that number of records, only these records will be returned and the method will return 0; if the cursor is already positioned after the last record, the method will return -1.
Parameters:
aTableName - String, the name of the table
cursorPosition - int, the cursor position to start retrieving the records from
numberOfRecords - int, number of records to be retrieved
aHashtableICollFormat - HashtableIndexedCollectionFormat, the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Returns:
int - new cursor position in the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getNextRecords

public Vector getNextRecords(java.lang.String aTableName,
                             int cursorPosition,
                             int numberOfRecords,
                             Vector vectorOfColumns)
                      throws DSESQLException,
                             DSEInvalidArgumentException,
                             DSEException
Gets the columns specified in vectorOfColumns argument of the next numberOfRecords records from the position set as cursorPosition in table aTableName. A Vector of Hashtables will be returned. Each Hashtable contains the data for one record. The Hashtable key is the column name and the Hashtable value is the column data. If the number of remaining records in the table from the current cursor is less that number of records, only these records will be returned; if the cursor is already positioned after the last record, an empty vector will be returned.
Parameters:
aTableName - String, the name of the table
cursorPosition - int, the cursor position to start retrieving the records from
numberOfRecords - int, number of records to be retrieved
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Returns:
com.ibm.dse.base.Vector - a Vector of as many Hashtables as retrieved records
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation

getNextRecords

public int getNextRecords(java.lang.String aTableName,
                          int cursorPosition,
                          int numberOfRecords,
                          java.lang.String aHashtableICollFormatName,
                          Context aContext)
                   throws DSESQLException,
                          DSEInvalidArgumentException,
                          DSEException,
                          java.io.IOException
Gets all columns of the next numberOfRecords records from the cursor position set as cursorPosition in table aTableName. A Vector of Hashtables will be returned. Each Hashtable contains the data for one record. The Hashtable key is the column name and the Hashtable value is the column data. The context aContext is then updated with the result of the query by using the formatter named aHashtableICollFormatName. If the number of remaining records in the table from the current cursor is less that number of records, only these records will be returned and the method will return 0; if the cursor is already positioned after the last record, the method will return -1.
Parameters:
aTableName - String, the name of the table
cursorPosition - int, the cursor position to start retrieving the records from
numberOfRecords - int, number of records to be retrieved
aHashtableICollFormatName - String, the name of the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
Returns:
int - new cursor position in the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getNextRecords

public int getNextRecords(java.lang.String aTableName,
                          int cursorPosition,
                          int numberOfRecords,
                          java.lang.String aHashtableICollFormatName,
                          Context aContext,
                          Vector vectorOfColumns)
                   throws DSESQLException,
                          DSEInvalidArgumentException,
                          DSEException,
                          java.io.IOException
Gets the columns specified in vectorOfColumns argument of the next numberOfRecords records from the cursor position set as cursorPosition in table aTableName. A Vector of Hashtables will be returned. Each Hashtable contains the data for one record. The Hashtable key is the column name and the Hashtable value is the column data. The context aContext is then updated with the result of the query by using the formatter named aHashtableICollFormatName. If the number of remaining records in the table from the current cursor is less that number of records, only these records will be returned and the method will return 0; if the cursor is already positioned after the last record, the method will return -1.
Parameters:
aTableName - String, the name of the table
cursorPosition - int, the cursor position to start retrieving the records from
numberOfRecords - int, number of records to be retrieved
aHashtableICollFormatName - String, the name of the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Returns:
int - new cursor position in the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getPrimaryKey

public java.lang.String getPrimaryKey(java.lang.String aTableName)
                               throws DSESQLException
Returns the name of the table aTableName column that is primary key.
Parameters:
aTableName - java.lang.String
Returns:
java.lang.String
Throws:
DSESQLException - if an SQLException occurs

getRecord

public Hashtable getRecord(java.lang.String aTableName,
                           java.lang.Object key)
                    throws DSESQLException,
                           DSEInvalidArgumentException,
                           DSEInvalidRequestException,
                           DSEException
Gets all columns of the record identified by a key from the table aTableName. A Hashtable with key the column name and value the column value is returned.
Parameters:
aTableName - String, the name of the table
key - Object, Object with the key value that identifies the record to be retrieved
Returns:
com.ibm.dse.base.Hashtable - a Hashtable with the retrieved record
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation

getRecord

public void getRecord(java.lang.String aTableName,
                      java.lang.Object key,
                      HashtableFormat aHashtableFormat,
                      Context aContext)
               throws DSESQLException,
                      DSEInvalidArgumentException,
                      DSEInvalidRequestException,
                      DSEException
Gets all columns of the record identified by a key from the table aTableName. The context aContext is then updated with the result of the query by using the formatter aHashtableFormat.
Parameters:
aTableName - String, the name of the table
key - Object, Object with the key value that identifies the record to be retrieved
aHashtableFormat - HashtableFormat, the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation

getRecord

public void getRecord(java.lang.String aTableName,
                      java.lang.Object key,
                      HashtableFormat aHashtableFormat,
                      Context aContext,
                      Vector vectorOfColumns)
               throws DSESQLException,
                      DSEInvalidArgumentException,
                      DSEInvalidRequestException,
                      DSEException
Gets the columns specified in vectorOfColumns argument of the record identified by key from the table aTableName. The context aContext is then updated with the result of the query by using the formatter aHashtableFormat.
Parameters:
aTableName - String, the name of the table
aHashtableFormat - HashtableFormat, the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation

getRecord

public Hashtable getRecord(java.lang.String aTableName,
                           java.lang.Object key,
                           Vector vectorOfColumns)
                    throws DSESQLException,
                           DSEInvalidArgumentException,
                           DSEInvalidRequestException,
                           DSEException
Gets the columns specified in vectorOfColumns argument of the record identified by a key from the table aTableName. A Hashtable with key the column name and value the column value is returned.
Parameters:
aTableName - String, the name of the table
key - Object, Object with the key value that identifies the record to be retrieved
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Returns:
com.ibm.dse.base.Hashtable - a Hashtable with the retrieved record
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation

getRecord

public void getRecord(java.lang.String aTableName,
                      java.lang.Object key,
                      java.lang.String aHashtableFormatName,
                      Context aContext)
               throws DSESQLException,
                      DSEInvalidArgumentException,
                      DSEInvalidRequestException,
                      DSEException,
                      java.io.IOException
Gets all columns of the record identified by key from the table aTableName. The context aContext is then updated with the result of the query by the using the formatter named aHashtableFormatName.
Parameters:
aTableName - String, the name of the table
aHashtableFormatName - String, the name of the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getRecord

public void getRecord(java.lang.String aTableName,
                      java.lang.Object key,
                      java.lang.String aHashtableFormatName,
                      Context aContext,
                      Vector vectorOfColumns)
               throws DSESQLException,
                      DSEInvalidArgumentException,
                      DSEInvalidRequestException,
                      DSEException,
                      java.io.IOException
Gets the columns specified in vectorOfColumns argument of the record identified by key from the table aTableName. The context aContext is then updated with the result of the query by using the formatter named aHashtableFormatName.
Parameters:
aTableName - String, the name of the table
aHashtableFormatName - String, the name of the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getRecords

public Vector getRecords(java.lang.String aTableName,
                         java.lang.Object keyFrom,
                         java.lang.Object keyTo)
                  throws DSESQLException,
                         DSEInvalidArgumentException,
                         DSEInvalidRequestException,
                         DSEException
Gets all columns of the records with primary key between keyFrom and keyTo values from the table aTableName. A Vector of Hashtables will be returned. Each Hashtable contains the data for one record. The Hashtable key is the column name and the Hashtable value is the column data.
Parameters:
aTableName - String, the name of the table
keyFrom - Object, Object with a key value. Only records with primary key value exceeding this value will be retrieved
keyTo - Object, Object with a key value. Only records with primary key value minor than this value will be retrieved
Returns:
com.ibm.dse.base.Vector - a Vector of as many Hashtables as retrieved records
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation

getRecords

public void getRecords(java.lang.String aTableName,
                       java.lang.Object keyFrom,
                       java.lang.Object keyTo,
                       HashtableIndexedCollectionFormat aHashtableICollFormat,
                       Context aContext)
                throws DSESQLException,
                       DSEInvalidArgumentException,
                       DSEInvalidRequestException,
                       DSEException,
                       java.io.IOException
Gets all columns of the records with primary key between keyFrom and keyTo from the table aTableName. The context aContext is then updated with the result of the query by using the formatter aHashtableICollFormat.
Parameters:
aTableName - String, the name of the table
keyFrom - Object, Object with a key value. Only records with primary key value exceeding this value will be retrieved
keyTo - Object, Object with a key value. Only records with primary key value minor than this value will be retrieved
aHashtableICollFormat - HashtableIndexedCollectionFormat, the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getRecords

public void getRecords(java.lang.String aTableName,
                       java.lang.Object keyFrom,
                       java.lang.Object keyTo,
                       HashtableIndexedCollectionFormat aHashtableICollFormat,
                       Context aContext,
                       Vector vectorOfColumns)
                throws DSESQLException,
                       DSEInvalidArgumentException,
                       DSEInvalidRequestException,
                       DSEException,
                       java.io.IOException
Gets the columns specified in vectorOfColumns argument of the records with primary key between keyFrom and keyTo from the table aTableName. The context aContext is then updated with the result of the query by using the formatter aHashtableICollFormat.
Parameters:
aTableName - String, the name of the table
keyFrom - Object, Object with a key value. Only records with primary key value exceeding this value will be retrieved
keyTo - Object, Object with a key value. Only records with primary key value minor than this value will be retrieved
aHashtableICollFormat - HashtableIndexedCollectionFormat, the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getRecords

public Vector getRecords(java.lang.String aTableName,
                         java.lang.Object keyFrom,
                         java.lang.Object keyTo,
                         Vector vectorOfColumns)
                  throws DSESQLException,
                         DSEInvalidArgumentException,
                         DSEInvalidRequestException,
                         DSEException
Gets the columns specified in vectorOfColumns argument of the records with primary key between keyFrom and keyTo from the table aTableName. A Vector of Hashtables will be returned. Each Hashtable contains the data for one record. The Hashtable key is the column name and the Hashtable value is the column data.
Parameters:
aTableName - String, the name of the table
keyFrom - Object, Object with a key value. Only records with primary key value exceeding this value will be retrieved
keyTo - Object, Object with a key value. Only records with primary key value minor than this value will be retrieved
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Returns:
com.ibm.dse.base.Vector - a Vector of as many Hashtables as retrieved records
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation

getRecords

public void getRecords(java.lang.String aTableName,
                       java.lang.Object keyFrom,
                       java.lang.Object keyTo,
                       java.lang.String aHashtableICollFormatName,
                       Context aContext)
                throws DSESQLException,
                       DSEInvalidArgumentException,
                       DSEInvalidRequestException,
                       DSEException,
                       java.io.IOException
Gets all columns of the records with primary key between keyFrom and keyTo from the table aTableName. The context aContext is then updated with the result of the query by using the formatter named aHashtableICollFormatName.
Parameters:
aTableName - String, the name of the table
keyFrom - Object, Object with a key value. Only records with primary key value exceeding this value will be retrieved
keyTo - Object, Object with a key value. Only records with primary key value minor than this value will be retrieved
aHashtableICollFormatName - String, the name of the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getRecords

public void getRecords(java.lang.String aTableName,
                       java.lang.Object keyFrom,
                       java.lang.Object keyTo,
                       java.lang.String aHashtableICollFormatName,
                       Context aContext,
                       Vector vectorOfColumns)
                throws DSESQLException,
                       DSEInvalidArgumentException,
                       DSEInvalidRequestException,
                       DSEException,
                       java.io.IOException
Gets the columns specified in vectorOfColumns argument of the records with primary key between keyFrom and keyTo from the table aTableName. The context aContext is then updated with the result of the query by using the formatter named aHashtableICollFormatName.
Parameters:
aTableName - String, the name of the table
keyFrom - Object, Object with a key value. Only records with primary key value exceeding this value will be retrieved
keyTo - Object, Object with a key value. Only records with primary key value minor than this value will be retrieved
aHashtableICollFormatName - String, the name of the formatter to be used to unformat the retrieved data
aContext - Context, the context that will be updated with the retrieved data
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSEInvalidRequestException - if the primary key name cannot be found
DSESQLException - if an SQLException occurs
DSEException - if an exception occurs when running the Application Tables operation
java.io.IOException - if there is a problem when reading the formatter from its external definition

getTableNames

public Vector getTableNames()
                     throws DSESQLException
Returns a Vector with the name of all tables created in the memory database.
Returns:
com.ibm.dse.base.Vector

getTableRecords

public java.lang.Object getTableRecords(java.lang.String aTableName,
                                        java.lang.String stOrder,
                                        java.lang.String stFilter)
                                 throws DSESQLException
Returns an Object containing all the records in the table aTable name matching the stFilter search condition and ordered as set in the stOrder argument.
Parameters:
aTableName - String, the name of the table
stOrder - String, name of the column the retrieve records will be ordered by
stFilter - String, additional search condition
Returns:
Object - Object keeping all table records information
Throws:
DSESQLException - if an SQLException occurs

getTableRecords

public java.lang.Object getTableRecords(java.lang.String aTableName,
                                        java.lang.String stOrder,
                                        java.lang.String stFilter,
                                        Vector vectorOfColumns)
                                 throws DSESQLException
Returns an Object containing all records in the table aTable name matching the stFilter search condition and ordered as set in the stOrder argument. Only the columns specified in the vectorOfColumns vector should be retrieved.
Parameters:
aTableName - String, the name of the table
stOrder - String, name of the column the retrieve records will be ordered by
stFilter - String, additional search condition
vectorOfColumns - Vector, vector with the name of the columns that will be retrieved from the table
Returns:
Object - Object keeping all table records information
Throws:
DSESQLException - if an SQLException occurs

manageRecord

public Hashtable manageRecord(java.lang.String aTableName,
                              java.lang.Object records)
                       throws DSEInvalidArgumentException,
                              DSESQLException,
                              DSEInternalErrorException
Returns a Hashtable containing the data of the record retrieved by executing the getTableRecords() method. The Hashtable key is the column name and the value is the column value.
Parameters:
aTableName - String, the name of the table
records - Object, an Object with the retrieved record information
Returns:
com.ibm.dse.base.Hashtable - A Hashtable with the retrieved record data
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEInternalErrorException - if an exception occurs when converting the record data into a Hashtable

manageRecords

public Vector manageRecords(java.lang.String aTableName,
                            int cursorPosition,
                            int numberOfRecords,
                            java.lang.Object records)
                     throws DSEInvalidArgumentException,
                            DSESQLException,
                            DSEInternalErrorException
Returns a Vector of Hashtables. Each Hashtable contains the data for one of the records obtained by calling the getTableRecords() method . The size of the Vector of Hashtables will be less or equal to numberOfRecords and the first record will be the one in the cursorPosition position. The Hashtable key is the column name and the Hashtable value is the column data.
Parameters:
aTableName - String, the name of the table
cursorPosition - int, the cursor position to start retrieving the records from
numberOfRecords - int, number of records to be retrieved from the set of all retrieved records
records - Object, an Object with the retrieved record information
Returns:
com.ibm.dse.base.Vector - A Vector of Hashtables each one holding one of the retrieved records
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEInternalErrorException - if an exception occurs when converting the record data into a Hashtable

manageRecords

public Vector manageRecords(java.lang.String aTableName,
                            java.lang.Object records)
                     throws DSEInvalidArgumentException,
                            DSESQLException,
                            DSEInternalErrorException
Returns a Vector of Hashtables. Each Hashtable contains the data for one of the records obtained by calling the getTableRecords() method . The Hashtable key is the column name and the Hashtable value is the column data.
Parameters:
aTableName - String, the name of the table
records - Object, an Object with the retrieved record information
Returns:
com.ibm.dse.base.Vector - A Vector of Hashtables each one holding one of the retrieved records
Throws:
DSEInvalidArgumentException - if the parameters are not correct
DSESQLException - if an SQLException occurs
DSEInternalErrorException - if an exception occurs when converting the record data into a Hashtable