IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.services.jdbc
Interface TableService

All Superinterfaces:
DatabaseConnect
All Known Implementing Classes:
JDBCTable

public interface TableService
extends DatabaseConnect

The TableService interface provides the public methods used to access tables services. Each class that includes the TableService interface must implement all of these methods.


Method Summary
 void addRecord(Context aContext, HashtableFormat aHashtableFormat)
          Adds a record into selected database table.
 void addRecord(Context aContext, HashtableFormat aHashtableFormat, Vector aColumnsVector)
          Adds a record into the selected database table.
 void addRecord(Context aContext, java.lang.String aFormatName)
          Adds a record into selected database table.
 void addRecord(Context aContext, java.lang.String aFormatName, Vector aColumnsVector)
          Adds a record into selected database table.
 void addRecord(Hashtable aDataHashtable)
          Inserts the data from aDataHashtable as a new row into the table assigned to the table service.
 void addRecord(Hashtable aDataHashtable, Vector aColumnsVector)
          Inserts the data from aDataHashtable as a new row into the table assigned to the table service.
 void commit()
          Commits all changes to the database.
 void deleteRecordsMatching(java.lang.String aSearchCondition)
          Deletes the records in the database table that match the search criteria.
 void executeProcedure(java.lang.String procedureName, Context aContext, HashtableFormat aHashtableInputFormat)
          Builds a data hashtable by calling the format method of the aHashtableInputFormat table formatter, with the context aContext as argument.
 void executeProcedure(java.lang.String procedureName, Context aContext, HashtableFormat aHashtableInputFormat, HashtableFormat aHashtableOutputFormat)
          Builds a data hashtable by calling the format method of the aHashtableFormat table formatter, with the context aContext as argument.
 void executeProcedure(java.lang.String procedureName, Context aContext, HashtableFormat aHashtableInputFormat, java.lang.String aHashtableOutputFormatName)
          Builds a data hashtable by calling the format method of the aHashtableFormat table formatter, with the context aContext as argument.
 void executeProcedure(java.lang.String procedureName, Context aContext, Hashtable dataHashtable, HashtableFormat aHashtableOutputFormat)
          Executes the stored procedure procedureName with the parameters given in the dataHashtable.
 void executeProcedure(java.lang.String procedureName, Context aContext, Hashtable dataHashtable, java.lang.String aHashtableOutputFormatName)
          Executes the stored procedure procedureName with the parameters given in the dataHashtable.
 void executeProcedure(java.lang.String procedureName, Context aContext, java.lang.String aHashtableFormatName)
          Instantiates the HashtableFormat defined as aHashtableFormatName and passes it as argument to the method executeProcedure (String, Context, HashtableFormat) .
 void executeProcedure(java.lang.String procedureName, Context aContext, java.lang.String aHashtableInputFormatName, java.lang.String aHashtableOutputFormatName)
          Instantiates the HashtableFormat defined as aHashtableInputFormatName and passes it as argument to the method executeProcedure (String, Context, HashtableFormat, String).
 void executeProcedure(java.lang.String procedureName, Hashtable dataHashtable)
          Executes the stored procedure procedureName with the parameters given in the dataHashtable
 void executeSQLQuery(java.lang.String anSQLStatement, java.lang.String outputFormatName, Context aContext)
          Executes an SQL Query Statement and unformats into aContext the result set using the outputFormatName
 int executeSQLUpdate(java.lang.String aSQLStatement)
          Executes an SQL Update Statement and returns the update count (the number of registers that have been updated)
 boolean getAutoCommit()
          Returns the autoCommit attribute value.
 boolean getAutoConnect()
          Returns the autoConnect attribute value.
 java.lang.String getCatalogName()
          Returns the catalog attribute value.
 java.lang.String getFullTableName()
          Returns the fullTableName attribute value.
 java.lang.String getJDBCDriver()
          Returns the JDBCDriver attribute value.
 java.lang.String getPassword()
          Returns the password attribute value.
 java.lang.String getSchemaName()
          Returns the schema attribute value.
 java.lang.String getTableName()
          Returns the tableName attribute value.
 java.lang.String getUser()
          Returns the user attribute value.
 boolean isPrimaryKeys()
          Returns the value of the attribute that decides whether the service has to control the database tables primary keys access or not.
 void loadDriver()
          Loads the default JDBC driver set in the TableConstants class.
 void loadDriver(java.lang.String aDriverName)
          Loads the JDBC Driver set as an argument.
 Vector retrieveRecordsMatching(java.lang.String aSearchCondition)
          Retrieves all records within the database table that match the Search Condition.
 void retrieveRecordsMatching(java.lang.String aSearchCondition, Context aContext, HashtableIndexedCollectionFormat anOutputFormat)
          Retrieves all the records within the database table, which is managed by the table service, and that match the search condition.
 void retrieveRecordsMatching(java.lang.String aSearchCondition, Context aContext, java.lang.String anOutputFormatName)
          Retrieves all the records within the database table, which is managed by the table service, and that match the search condition.
 Vector retrieveRecordsMatching(java.lang.String aSearchCondition, Vector aColumnsVector)
          Retrieves the columns in aColumnsVector of all the records within the database table that match the search condition.
 void retrieveRecordsMatching(java.lang.String aSearchCondition, Vector aColumnsVector, Context aContext, HashtableIndexedCollectionFormat anOutputFormat)
          Retrieves the columns in aColumnsVector of all the records within the database table that match the search condition.
 void retrieveRecordsMatching(java.lang.String aSearchCondition, Vector aColumnsVector, Context aContext, java.lang.String anOutputFormatName)
          Retrieves the columns in aColumnsVector of all the records within the database table that match the search condition.
 void rollback()
          Rolls back all database changes.
 void setAutoCommit(boolean s)
          Sets the autoCommit attribute to the boolean provided as an argument.
 void setAutoConnect(boolean s)
          Sets the autoConnect attribute to the boolean provided as an argument.
 void setCatalogName(java.lang.String s)
          Sets the catalog attribute to the string provided as argument.
 void setJDBCDriver(java.lang.String newJDBCDriver)
          Sets the JDBCDriver attribute value to newJDBCDriver.
 void setPassword(java.lang.String s)
          Sets the password attribute to the string provided as an argument.
 void setPrimaryKeys(boolean newPrimaryKeys)
          Sets the primaryKeys attribute value to newPrimaryKeys.
 void setSchemaName(java.lang.String s)
          Sets the schemaName attribute to the String provided as an argument.
 void setTableName(java.lang.String s)
          Sets the tableName attribute to the String provided as an argument.
 void setUser(java.lang.String s)
          Sets the user attribute to the string provided as an argument.
 int updateRecordsMatching(java.lang.String aSearchCondition, Context aContext, HashtableFormat aHashtableFormat)
          Updates all of the table records that match the search condition with the result from formatting the context aContext data using the formatter aHashtableFormat.
 int updateRecordsMatching(java.lang.String aSearchCondition, Context aContext, HashtableFormat aHashtableFormat, Vector aColumnsVector)
          Updates the columns specified in aColumnsVector for the records which match the search condition, with the data provided in the operation context.
 int updateRecordsMatching(java.lang.String aSearchCondition, Context aContext, java.lang.String aFormatName)
          Updates all of the table records that match the search condition with the result from formatting the context aContext data using the formatter identified by aFormatName.
 int updateRecordsMatching(java.lang.String aSearchCondition, Context aContext, java.lang.String aFormatName, Vector aColumnsVector)
          For all the table records that match the search condition, updates the columns specified in aColumnsVector with the data included in the operation context aContext.
 int updateRecordsMatching(java.lang.String aSearchCondition, Hashtable aDataHashtable)
          Updates all of the table records that match the search condition with the data included in the Hashtable argument.
 int updateRecordsMatching(java.lang.String aSearchCondition, Hashtable aDataHashtable, Vector aColumnsVector)
          For all of the table records that match the search condition, updates the columns specified in aColumnsVector with the data included in Hashtable argument.
 
Methods inherited from interface com.ibm.btt.services.jdbc.DatabaseConnect
connect, connect, connect, connect, connect, connect, disconnect, getDatabaseURL, getDataSourceName, getPoolName, getSharedConnection, isConnected, isWaitRetry, setDatabaseURL, setDataSourceName, setPoolName, setSharedConnection, setWaitRetry
 

Method Detail

addRecord

void addRecord(Context aContext,
               HashtableFormat aHashtableFormat)
               throws DSEInvalidArgumentException,
                      DSEInvalidRequestException,
                      DSEInternalErrorException,
                      DSESQLException,
                      DSEException,
                      DSEInvalidClassException
Adds a record into selected database table. The record is built by calling the format method of the aHashtableFormat table formatter, with the context aContext as argument.

Parameters:
aContext - com.ibm.dse.base.Context
aHashtableFormat - com.ibm.dse.base.HashtableFormat
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInvalidRequestException - if the request is not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections manager
DSEInvalidClassException - if there is an error in the formatting process

addRecord

void addRecord(Context aContext,
               HashtableFormat aHashtableFormat,
               Vector aColumnsVector)
               throws DSEInvalidArgumentException,
                      DSEInvalidRequestException,
                      DSEInternalErrorException,
                      DSESQLException,
                      DSEException,
                      DSEInvalidClassException
Adds a record into the selected database table. Only the columns specified in aColumnsVector will be set. The record is built by calling the format method of the aHashtableFormat table formatter, with the context aContext as argument. The formatter definition must only contain the reference to the columns in the aColumnsVector argument.

Parameters:
aContext - com.ibm.dse.base.Context
aHashtableFormat - com.ibm.dse.base.HashtableFormat - the table formatter
aColumnsVector - com.ibm.dse.base.Vector - the vector that contains the columns to be added
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInvalidRequestException - if the request is not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections
DSEInvalidClassException - if there is an error in the formatting process

addRecord

void addRecord(Context aContext,
               java.lang.String aFormatName)
               throws DSEInvalidArgumentException,
                      DSEInvalidRequestException,
                      DSEInternalErrorException,
                      DSESQLException,
                      DSEException,
                      DSEInvalidClassException,
                      java.io.IOException
Adds a record into selected database table. The record is built by calling the format method of the table formatter identified by aFormatName, with the context aContext as argument.

Parameters:
aContext - com.ibm.dse.base.Context
aFormatName - java.lang.String
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInvalidRequestException - if the request is not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections manager
DSEInvalidClassException - if there is an error in the formatting process
java.io.IOException - if there is an error instanciating the formatter from its external definition

addRecord

void addRecord(Context aContext,
               java.lang.String aFormatName,
               Vector aColumnsVector)
               throws DSEInvalidArgumentException,
                      DSEInvalidRequestException,
                      DSEInternalErrorException,
                      DSESQLException,
                      DSEException,
                      DSEInvalidClassException,
                      java.io.IOException
Adds a record into selected database table. Only the columns specified in the aColumnsVector argument will be set. The record is built by calling the format method of the table formatter identified by aFormatName, with the context aContext as argument. The formatter definition must only contain the reference to the columns in the aColumnsVector argument.

Parameters:
aContext - com.ibm.dse.base.Context
aFormatName - java.lang.String - the table formatter name
aColumnsVector - com.ibm.dse.base.Vector - the vector that contains the columns to be added
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInvalidRequestException - if the request is not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections
DSEInvalidClassException - if there is an error in the formatting process
java.io.IOException - if there is an error instanciating the formatter from its external definition

addRecord

void addRecord(Hashtable aDataHashtable)
               throws DSEInvalidRequestException,
                      DSEInvalidArgumentException,
                      DSEInternalErrorException,
                      DSESQLException,
                      DSEException
Inserts the data from aDataHashtable as a new row into the table assigned to the table service. The data hashtable has the format: key=data_field_name, value=data_field_value

Parameters:
aDataHashtable - Hashtable
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInvalidRequestException - if the request is not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections manager

addRecord

void addRecord(Hashtable aDataHashtable,
               Vector aColumnsVector)
               throws DSEInvalidArgumentException,
                      DSEInternalErrorException,
                      DSEInvalidRequestException,
                      DSESQLException,
                      DSEException
Inserts the data from aDataHashtable as a new row into the table assigned to the table service. The data hashtable has the format: key=data_field_name, value=data_field_value Only the columns specified in aColumnsVector argument will be set.

Parameters:
aDataHashtable - com.ibm.dse.base.Hashtable - the Hashtable that contains the data
aColumnsVector - com.ibm.dse.base.Vector the vector that contains the columns to be added
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSEInvalidRequestException - if the request is not valid
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections

commit

void commit()
            throws DSESQLException
Commits all changes to the database.

Throws:
DSESQLException - if commit fails

deleteRecordsMatching

void deleteRecordsMatching(java.lang.String aSearchCondition)
                           throws DSEInvalidArgumentException,
                                  DSEInvalidRequestException,
                                  DSEInternalErrorException,
                                  DSESQLException,
                                  DSEException
Deletes the records in the database table that match the search criteria.

Parameters:
aSearchCondition - java.lang.String - the search criteria in SQL format
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInvalidRequestException - if the request is not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQL Exception is caught
DSEException - if an exception is thrown when calling the pool of connections manager

executeProcedure

void executeProcedure(java.lang.String procedureName,
                      Context aContext,
                      Hashtable dataHashtable,
                      HashtableFormat aHashtableOutputFormat)
                      throws DSEInvalidArgumentException,
                             DSEInvalidRequestException,
                             DSEInternalErrorException,
                             DSESQLException,
                             DSEInvalidRequestException,
                             DSEException
Executes the stored procedure procedureName with the parameters given in the dataHashtable. The output parameters are unformatted with aHashtableOutputFormat into aContext.

Parameters:
procedureName - java.lang.String
dataHashtable - com.ibm.dse.base.Hashtable
aContext - com.ibm.dse.base.Context
aHashtableOutputFormat - com.ibm.dse.base.HashtableFormat
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEInvalidRequestException - if the request is not valid
DSEException - if an exception is thrown when calling the pool of connections manager

executeProcedure

void executeProcedure(java.lang.String procedureName,
                      Context aContext,
                      Hashtable dataHashtable,
                      java.lang.String aHashtableOutputFormatName)
                      throws DSEInternalErrorException,
                             DSESQLException,
                             DSEInvalidArgumentException,
                             DSEInvalidRequestException,
                             DSEException,
                             java.io.IOException
Executes the stored procedure procedureName with the parameters given in the dataHashtable. The output parameters are unformatted with formatter aHashtableFormatName into aContext.

Parameters:
procedureName - java.lang.String
dataHashtable - com.ibm.dse.base.Hashtable
aContext - com.ibm.dse.base.Context
aHashtableOutputFormatName - java.lang.String
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEInvalidRequestException - if the request is not valid
DSEException - if an exception is thrown when calling the pool of connections manager
java.io.IOException - if there is an error instanciating the formatter from its external definition

executeProcedure

void executeProcedure(java.lang.String procedureName,
                      Context aContext,
                      HashtableFormat aHashtableInputFormat)
                      throws DSEInternalErrorException,
                             DSESQLException,
                             DSEInvalidArgumentException,
                             DSEException,
                             DSEInvalidRequestException
Builds a data hashtable by calling the format method of the aHashtableInputFormat table formatter, with the context aContext as argument. The returned Hashtable instance is then passed as parameter of the executeProcedure (String, Hashtable) method.

Parameters:
procedureName - java.lang.String
aContext - com.ibm.dse.base.Context
aHashtableInputFormat - com.ibm.dse.base.HashtableFormat
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQL Exception is caught
DSEInvalidRequestException - if the request is not valid
DSEException - if an exception is thrown when calling the pool of connections manager

executeProcedure

void executeProcedure(java.lang.String procedureName,
                      Context aContext,
                      HashtableFormat aHashtableInputFormat,
                      HashtableFormat aHashtableOutputFormat)
                      throws DSEInvalidArgumentException,
                             DSEInternalErrorException,
                             DSESQLException,
                             DSEInvalidRequestException,
                             DSEException
Builds a data hashtable by calling the format method of the aHashtableFormat table formatter, with the context aContext as argument. The returned Hashtable instance is then passed as parameter of the executeProcedure (String, Context, Hashtable, HashtableFormat) method.

Parameters:
procedureName - java.lang.String
aContext - com.ibm.dse.base.Context
aHashtableInputFormat - com.ibm.dse.base.HashtableFormat
aHashtableOutputFormat - com.ibm.dse.base.HashtableFormat
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQL Exception is caught
DSEInvalidRequestException - if the request is not valid
DSEException - if an exception is thrown when calling the pool of connections manager

executeProcedure

void executeProcedure(java.lang.String procedureName,
                      Context aContext,
                      HashtableFormat aHashtableInputFormat,
                      java.lang.String aHashtableOutputFormatName)
                      throws DSEInvalidArgumentException,
                             DSEInternalErrorException,
                             DSESQLException,
                             DSEInvalidRequestException,
                             DSEException,
                             java.io.IOException
Builds a data hashtable by calling the format method of the aHashtableFormat table formatter, with the context aContext as argument. The returned Hashtable instance is then passed as parameter of the executeProcedure (String, Context, Hashtable, String) method.

Parameters:
procedureName - java.lang.String
aContext - com.ibm.dse.base.Context
aHashtableInputFormat - com.ibm.dse.base.HashtableFormat
aHashtableOutputFormatName - java.lang.String
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEInvalidRequestException - if the request is not valid
DSEException - if an exception is thrown when calling the pool of connections manager
java.io.IOException - if there is an error instanciating the formatter from its external definition

executeProcedure

void executeProcedure(java.lang.String procedureName,
                      Context aContext,
                      java.lang.String aHashtableFormatName)
                      throws DSEInvalidArgumentException,
                             DSEInternalErrorException,
                             DSESQLException,
                             DSEException,
                             DSEInvalidRequestException,
                             java.io.IOException
Instantiates the HashtableFormat defined as aHashtableFormatName and passes it as argument to the method executeProcedure (String, Context, HashtableFormat) .

Parameters:
procedureName - java.lang.String
aContext - com.ibm.dse.base.Context
aHashtableFormatName - java.lang.String
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEInvalidRequestException - if the request is not valid
DSEException - if an exception is thrown when calling the pool of connections manager
java.io.IOException - if there is an error instanciating the formatter from its external definition

executeProcedure

void executeProcedure(java.lang.String procedureName,
                      Context aContext,
                      java.lang.String aHashtableInputFormatName,
                      java.lang.String aHashtableOutputFormatName)
                      throws DSEInvalidArgumentException,
                             DSEInternalErrorException,
                             DSESQLException,
                             DSEInvalidRequestException,
                             DSEException,
                             java.io.IOException
Instantiates the HashtableFormat defined as aHashtableInputFormatName and passes it as argument to the method executeProcedure (String, Context, HashtableFormat, String).

Parameters:
procedureName - java.lang.String
aContext - com.ibm.dse.base.Context
aHashtableInputFormatName - java.lang.String
aHashtableOutputFormatName - java.lang.String
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQL Exception is caught
DSEInvalidRequestException - if the request is not valid
DSEException - if an exception is thrown when calling the pool of connections manager
java.io.IOException - if there is an error instanciating the formatter from its external definition

executeProcedure

void executeProcedure(java.lang.String procedureName,
                      Hashtable dataHashtable)
                      throws DSESQLException,
                             DSEInvalidRequestException,
                             DSEInternalErrorException,
                             DSEException
Executes the stored procedure procedureName with the parameters given in the dataHashtable

Parameters:
procedureName - java.lang.String
dataHashtable - com.ibm.dse.base.Hashtable
Throws:
DSESQLException - if an SQLException is caught
DSEInvalidRequestException - if the request is not valid
DSEInternalErrorException - if an internal program error occurs
DSEException - if an exception is thrown when calling the pool of connections manager

executeSQLQuery

void executeSQLQuery(java.lang.String anSQLStatement,
                     java.lang.String outputFormatName,
                     Context aContext)
                     throws DSEInternalErrorException,
                            DSESQLException,
                            DSEInvalidArgumentException,
                            DSEInvalidRequestException,
                            DSEException,
                            DSEObjectNotFoundException,
                            java.io.IOException
Executes an SQL Query Statement and unformats into aContext the result set using the outputFormatName

Parameters:
anSQLStatement - java.lang.String
outputFormatName - java.lang.String
aContext - com.ibm.dse.base.Context
Throws:
DSEInvalidRequestException - if the request is not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections manager
DSEObjectNotFoundException - if there is an error in the unformatting process
java.io.IOException - if there is an error instanciating the formatter from its external definition
DSEInvalidArgumentException

executeSQLUpdate

int executeSQLUpdate(java.lang.String aSQLStatement)
                     throws DSESQLException,
                            DSEInvalidArgumentException,
                            DSEInternalErrorException,
                            DSEInvalidRequestException,
                            DSEException
Executes an SQL Update Statement and returns the update count (the number of registers that have been updated)

Parameters:
aSQLStatement - java.lang.String
Returns:
int
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEInvalidRequestException - if the request is not valid
DSEException - if an exception is thrown when calling the pool of connections manager

getAutoCommit

boolean getAutoCommit()
Returns the autoCommit attribute value.

Returns:
boolean

getAutoConnect

boolean getAutoConnect()
Returns the autoConnect attribute value.

Returns:
boolean

getCatalogName

java.lang.String getCatalogName()
Returns the catalog attribute value.

Returns:
java.lang.String

getFullTableName

java.lang.String getFullTableName()
Returns the fullTableName attribute value.

Returns:
java.lang.String

getJDBCDriver

java.lang.String getJDBCDriver()
Returns the JDBCDriver attribute value.

Returns:
java.lang.String

getPassword

java.lang.String getPassword()
Returns the password attribute value.

Returns:
java.lang.String

getSchemaName

java.lang.String getSchemaName()
Returns the schema attribute value.

Returns:
java.lang.String

getTableName

java.lang.String getTableName()
Returns the tableName attribute value.

Returns:
java.lang.String

getUser

java.lang.String getUser()
Returns the user attribute value.

Returns:
java.lang.String

isPrimaryKeys

boolean isPrimaryKeys()
Returns the value of the attribute that decides whether the service has to control the database tables primary keys access or not.

Returns:
boolean

loadDriver

void loadDriver()
                throws DSEInternalErrorException
Loads the default JDBC driver set in the TableConstants class.

Throws:
DSEInternalErrorException - if an internal program error occurs

loadDriver

void loadDriver(java.lang.String aDriverName)
                throws DSEInternalErrorException
Loads the JDBC Driver set as an argument.

Parameters:
aDriverName - java.lang.String, the driver name (full path)
Throws:
DSEInternalErrorException - if an internal program error occurs

retrieveRecordsMatching

Vector retrieveRecordsMatching(java.lang.String aSearchCondition)
                               throws DSEInternalErrorException,
                                      DSEInvalidRequestException,
                                      DSEInvalidArgumentException,
                                      DSESQLException,
                                      DSEException
Retrieves all records within the database table that match the Search Condition.

Parameters:
aSearchCondition - java.lang.String - the search condition in SQL format
Returns:
Vector - a vector of hash tables with the retrieved records
Throws:
DSEInvalidRequestException - if the request is not valid
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQL Exception is caught
DSEException - if an exception is thrown when calling the pool of connections manager

retrieveRecordsMatching

void retrieveRecordsMatching(java.lang.String aSearchCondition,
                             Context aContext,
                             HashtableIndexedCollectionFormat anOutputFormat)
                             throws DSEInternalErrorException,
                                    DSEInvalidRequestException,
                                    DSEInvalidArgumentException,
                                    DSESQLException,
                                    DSEException,
                                    java.io.IOException
Retrieves all the records within the database table, which is managed by the table service, and that match the search condition. The retrieved records are then unformatted into the context aContext using anOutputFormat.

Parameters:
aSearchCondition - java.lang.String - the search condition in SQL format
aContext - com.ibm.dse.base.Context - the context to where the retrieved records will be unformatted
anOutputFormat - com.ibm.dse.base.HashtableIndexedCollectionFormat - the formatter to unformat the retrieved records
Throws:
DSEInvalidRequestException - if the request is not valid
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections manager
java.io.IOException - if there is an error instanciating the formatter from its external definition

retrieveRecordsMatching

void retrieveRecordsMatching(java.lang.String aSearchCondition,
                             Context aContext,
                             java.lang.String anOutputFormatName)
                             throws DSEInternalErrorException,
                                    DSEInvalidRequestException,
                                    DSEInvalidArgumentException,
                                    DSESQLException,
                                    DSEException,
                                    java.io.IOException
Retrieves all the records within the database table, which is managed by the table service, and that match the search condition. The retrieved records are then unformatted into the context aContext using the format named anOutputFormatName.

Parameters:
aSearchCondition - java.lang.String - the search condition in SQL format
aContext - com.ibm.dse.base.Context - the context to where the retrieved records will be unformatted
anOutputFormatName - java.lang.String - the name of the formatter to unformat the retrieved records
Throws:
DSEInvalidRequestException - if the request is not valid
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections manager
java.io.IOException - if there is an error instanciating the formatter from its external definition

retrieveRecordsMatching

Vector retrieveRecordsMatching(java.lang.String aSearchCondition,
                               Vector aColumnsVector)
                               throws DSEInternalErrorException,
                                      DSEInvalidRequestException,
                                      DSEInvalidArgumentException,
                                      DSESQLException,
                                      DSEException
Retrieves the columns in aColumnsVector of all the records within the database table that match the search condition. The format used to put the retrieved data into the operation context must only unformat the returned column values.

Parameters:
aSearchCondition - java.lang.String - the search condition in SQL format
aColumnsVector - com.ibm.dse.base.Vector - the vector that contains the columns to be retrieved
Returns:
com.ibm.dse.base.Vector - the vector of hash tables with the retrieved records
Throws:
DSEInvalidRequestException - if the request is not valid
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQL Exception is caught
DSEException - if an exception is thrown when calling the pool of connections manager

retrieveRecordsMatching

void retrieveRecordsMatching(java.lang.String aSearchCondition,
                             Vector aColumnsVector,
                             Context aContext,
                             HashtableIndexedCollectionFormat anOutputFormat)
                             throws DSEInternalErrorException,
                                    DSEInvalidRequestException,
                                    DSEInvalidArgumentException,
                                    DSESQLException,
                                    DSEException,
                                    java.io.IOException
Retrieves the columns in aColumnsVector of all the records within the database table that match the search condition. The retrieved records are then unformatted into the context aContext using anOutputFormat.

Parameters:
aSearchCondition - java.lang.String - the search condition in SQL format
aColumnsVector - com.ibm.dse.base.Vector - the vector that contains the columns to be retrieved
aContext - com.ibm.dse.base.Context - the context to where the retrieved records will be unformatted
anOutputFormat - com.ibm.dse.base.HashtableIndexedCollectionFormat - the formatter to unformat the retrieved records
Throws:
DSEInvalidRequestException - if the request is not valid
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQL Exception is caught
DSEException - if an exception is thrown when calling the pool of connections manager
java.io.IOException

retrieveRecordsMatching

void retrieveRecordsMatching(java.lang.String aSearchCondition,
                             Vector aColumnsVector,
                             Context aContext,
                             java.lang.String anOutputFormatName)
                             throws DSEInternalErrorException,
                                    DSEInvalidRequestException,
                                    DSEInvalidArgumentException,
                                    DSESQLException,
                                    DSEException,
                                    java.io.IOException
Retrieves the columns in aColumnsVector of all the records within the database table that match the search condition. The retrieved records are then unformatted into the context aContext using the format named anOutputFormatName.

Parameters:
aSearchCondition - java.lang.String - the search condition in SQL format
aColumnsVector - com.ibm.dse.base.Vector - the vector that contains the columns to be retrieved
aContext - com.ibm.dse.base.Context - the context to where the retrieved records will be unformatted
anOutputFormatName - java.lang.String - the name of the formatter to unformat the retrieved records
Throws:
DSEInvalidRequestException - if the request is not valid
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQL Exception is caught
DSEException - if an exception is thrown when calling the pool of connections manager
java.io.IOException - if there is an error instanciating the formatter from its external definition

rollback

void rollback()
              throws DSESQLException
Rolls back all database changes.

Throws:
DSESQLException - when rollback fails

setAutoCommit

void setAutoCommit(boolean s)
Sets the autoCommit attribute to the boolean provided as an argument.

Parameters:
s - boolean

setAutoConnect

void setAutoConnect(boolean s)
Sets the autoConnect attribute to the boolean provided as an argument.

Parameters:
s - boolean

setCatalogName

void setCatalogName(java.lang.String s)
Sets the catalog attribute to the string provided as argument.

Parameters:
s - java.lang.String

setJDBCDriver

void setJDBCDriver(java.lang.String newJDBCDriver)
Sets the JDBCDriver attribute value to newJDBCDriver.

Parameters:
newJDBCDriver - java.lang.String

setPassword

void setPassword(java.lang.String s)
Sets the password attribute to the string provided as an argument.

Parameters:
s - java.lang.String

setPrimaryKeys

void setPrimaryKeys(boolean newPrimaryKeys)
Sets the primaryKeys attribute value to newPrimaryKeys.

Parameters:
newPrimaryKeys - boolean

setSchemaName

void setSchemaName(java.lang.String s)
Sets the schemaName attribute to the String provided as an argument.

Parameters:
s - String

setTableName

void setTableName(java.lang.String s)
Sets the tableName attribute to the String provided as an argument.

Parameters:
s - java.lang.String

setUser

void setUser(java.lang.String s)
Sets the user attribute to the string provided as an argument.

Parameters:
s - java.lang.String

updateRecordsMatching

int updateRecordsMatching(java.lang.String aSearchCondition,
                          Context aContext,
                          HashtableFormat aHashtableFormat)
                          throws DSEInvalidRequestException,
                                 DSEException,
                                 DSEInvalidArgumentException,
                                 DSESQLException
Updates all of the table records that match the search condition with the result from formatting the context aContext data using the formatter aHashtableFormat.

Parameters:
aSearchCondition - java.lang.String
aContext - com.ibm.dse.base.Context
aHashtableFormat - com.ibm.dse.base.HashtableFormat
Returns:
int - the number of updated records
Throws:
DSEInvalidArgumentException - if an argument is not valid
DSEInvalidRequestException - if the input parameters are not valid
DSEException - if an exception is thrown when calling the pool of connections manager
DSESQLException - if an SQLException is caught

updateRecordsMatching

int updateRecordsMatching(java.lang.String aSearchCondition,
                          Context aContext,
                          HashtableFormat aHashtableFormat,
                          Vector aColumnsVector)
                          throws DSEInvalidRequestException,
                                 DSEException,
                                 DSEInvalidArgumentException,
                                 DSESQLException
Updates the columns specified in aColumnsVector for the records which match the search condition, with the data provided in the operation context. The format aHashtableFormat must only format the new data values.

Parameters:
aSearchCondition - java.lang.String
aContext - com.ibm.dse.base.Context
aHashtableFormat - com.ibm.dse.base.HashtableFormat
aColumnsVector - com.ibm.dse.base.Vector - the vector that contains the columns to be updated
Returns:
int - the number of updated records
Throws:
DSEInvalidArgumentException - if an argument is not valid
DSEInvalidRequestException - if the input parameters are not valid
DSEException - if an exception is thrown when calling the pool of connections manager
DSESQLException - if an SQLException is caught

updateRecordsMatching

int updateRecordsMatching(java.lang.String aSearchCondition,
                          Context aContext,
                          java.lang.String aFormatName)
                          throws DSEInvalidRequestException,
                                 DSEInternalErrorException,
                                 DSEInvalidArgumentException,
                                 DSESQLException,
                                 DSEException,
                                 DSEInvalidClassException,
                                 java.io.IOException
Updates all of the table records that match the search condition with the result from formatting the context aContext data using the formatter identified by aFormatName.

Parameters:
aSearchCondition - java.lang.String
aContext - com.ibm.dse.base.Context
aFormatName - java.lang.String
Returns:
int - the number of updated records
Throws:
DSEInvalidArgumentException - if an argument is not valid
DSEInvalidRequestException - if the input parameters are not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections manager
DSEInvalidClassException - if there is an error in the formatting process
java.io.IOException - if there is an error instanciating the formatter from its external definition

updateRecordsMatching

int updateRecordsMatching(java.lang.String aSearchCondition,
                          Context aContext,
                          java.lang.String aFormatName,
                          Vector aColumnsVector)
                          throws DSEInvalidArgumentException,
                                 DSEInternalErrorException,
                                 DSEInvalidRequestException,
                                 DSESQLException,
                                 DSEException,
                                 DSEInvalidClassException,
                                 java.io.IOException
For all the table records that match the search condition, updates the columns specified in aColumnsVector with the data included in the operation context aContext.

Parameters:
aSearchCondition - java.lang.String - the search condition in SQL format
aContext - com.ibm.dse.base.Context
aFormatName - java.lang.String - the name of the format to be used to get the new data from the context
aColumnsVector - - a vector that contains the name of the columns to be updated
Returns:
int - the number of updated records
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSEInvalidRequestException - if the request is not valid
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections manager
DSEInvalidClassException - if there is an error in the formatting process
java.io.IOException - if there is an error instanciating the formatter from its external definition

updateRecordsMatching

int updateRecordsMatching(java.lang.String aSearchCondition,
                          Hashtable aDataHashtable)
                          throws DSEInvalidRequestException,
                                 DSEInternalErrorException,
                                 DSEInvalidArgumentException,
                                 DSESQLException,
                                 DSEException
Updates all of the table records that match the search condition with the data included in the Hashtable argument.

Parameters:
aSearchCondition - java.lang.String - the search condition in SQL format
aDataHashtable - com.ibm.dse.base.Hashtable
Returns:
int - the number of updated records
Throws:
DSEInvalidArgumentException - if an argument is not valid
DSEInvalidRequestException - if the input parameters are not valid
DSEInternalErrorException - if an internal program error occurs
DSESQLException - is an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections manager

updateRecordsMatching

int updateRecordsMatching(java.lang.String aSearchCondition,
                          Hashtable aDataHashtable,
                          Vector aColumnsVector)
                          throws DSEInvalidArgumentException,
                                 DSEInternalErrorException,
                                 DSEInvalidRequestException,
                                 DSESQLException,
                                 DSEException
For all of the table records that match the search condition, updates the columns specified in aColumnsVector with the data included in Hashtable argument.

Parameters:
aSearchCondition - java.lang.String - the search condition in SQL format
aDataHashtable - com.ibm.dse.base.Hashtable
aColumnsVector - - a vector that contains the name of the columns to be updated
Returns:
int - the number of updated records
Throws:
DSEInvalidArgumentException - if the argument(s) is(are) not valid
DSEInternalErrorException - if an internal program error occurs
DSEInvalidRequestException - if the request is not valid
DSESQLException - if an SQLException is caught
DSEException - if an exception is thrown when calling the pool of connections manager

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010