org.safs.model.commands

Class DDDriverDatabaseCommands

java.lang.Object

org.safs.model.commands.DDDriverDatabaseCommands

public class DDDriverDatabaseCommands
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYDBTABLECOLUMNTOFILE_KEYWORD "CopyDBTableColumnToFile"
static java.lang.String	COPYDBTABLETOFILE_KEYWORD "CopyDBTableToFile"
static java.lang.String	DELETEDBTABLERECORDS_KEYWORD "DeleteDBTableRecords"
static java.lang.String	EXECSQLQUERY_KEYWORD "ExecSQLQuery"
static java.lang.String	GETDBTABLECOLUMNCOUNT_KEYWORD "GetDBTableColumnCount"
static java.lang.String	GETDBTABLEROWCOUNT_KEYWORD "GetDBTableRowCount"
static java.lang.String	GETDBVALUE_KEYWORD "GetDBValue"
static java.lang.String	SETJDBCDRIVER_KEYWORD "SetJdbcDriver"
static java.lang.String	VERIFYDATABASENULLVALUE_KEYWORD "VerifyDatabaseNullValue"
static java.lang.String	VERIFYDATABASEVALUE_KEYWORD "VerifyDatabaseValue"
static java.lang.String	VERIFYDBNULLVALUE_KEYWORD "VerifyDBNullValue"
static java.lang.String	VERIFYDBVALUE_KEYWORD "VerifyDBValue"

Method Summary

Modifier and Type	Method and Description
static DriverCommand	copyDBTableColumnToFile(java.lang.String[] parameters) This routine will copy the contents of one or more DBTable column(s) to a file.
static DriverCommand	copyDBTableColumnToFile(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String fileOut, java.lang.String sQLQuery, java.lang.String directoryOut, java.lang.String sQLStatus, java.lang.String delimiter, java.lang.String userID, java.lang.String password) This routine will copy the contents of one or more DBTable column(s) to a file.
static DriverCommand	copyDBTableToFile(java.lang.String[] parameters) This routine will copy the contents of a DBTable to a file.
static DriverCommand	copyDBTableToFile(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String fileOut, java.lang.String dBTableName, java.lang.String columnCount, java.lang.String rowCount, java.lang.String sQLQuery, java.lang.String delimiter, java.lang.String directoryOut, java.lang.String sQLStatus, java.lang.String userID, java.lang.String password) This routine will copy the contents of a DBTable to a file.
static DriverCommand	deleteDBTableRecords(java.lang.String[] parameters) Deletes records in a database table Deletes records in a database table.
static DriverCommand	deleteDBTableRecords(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String sQLStatus) Deletes records in a database table Deletes records in a database table.
static DriverCommand	execSQLQuery(java.lang.String[] parameters) Executes the query provided in a queryStr on the database table.
static DriverCommand	execSQLQuery(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String queryStr, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password) Executes the query provided in a queryStr on the database table.
static DriverCommand	getDBTableColumnCount(java.lang.String[] parameters) Executes the query in a specified database table and returns the total column count.
static DriverCommand	getDBTableColumnCount(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String dBTableName, java.lang.String columnCount, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password) Executes the query in a specified database table and returns the total column count.
static DriverCommand	getDBTableRowCount(java.lang.String[] parameters) Executes the query in a database table.
static DriverCommand	getDBTableRowCount(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String dBTableName, java.lang.String rowCount, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password) Executes the query in a database table.
static DriverCommand	getDBValue(java.lang.String[] parameters) Executes the query and returns the case-sensitive value as result of the execution.
static DriverCommand	getDBValue(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String queryStr, java.lang.String queryResult, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password) Executes the query and returns the case-sensitive value as result of the execution.
static DDDriverDatabaseCommands	getInstance() public Singleton to access class static methods via instance
static DriverCommand	setJdbcDriver(java.lang.String driverClassName) set Jdbc Driver sets a JDBC driver, can be called more than once with multiple drivers.
static DriverCommand	verifyDatabaseNullValue(java.lang.String[] parameters) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
static DriverCommand	verifyDatabaseNullValue(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String sQLStatus) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
static DriverCommand	verifyDatabaseValue(java.lang.String[] parameters) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
static DriverCommand	verifyDatabaseValue(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String expectedValue, java.lang.String sQLStatus) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
static DriverCommand	verifyDBNullValue(java.lang.String[] parameters) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
static DriverCommand	verifyDBNullValue(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String sQLStatus) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
static DriverCommand	verifyDBValue(java.lang.String[] parameters) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
static DriverCommand	verifyDBValue(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String expectedValue, java.lang.String sQLStatus) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYDBTABLECOLUMNTOFILE_KEYWORD

public static final java.lang.String COPYDBTABLECOLUMNTOFILE_KEYWORD

"CopyDBTableColumnToFile"

See Also:

Constant Field Values

COPYDBTABLETOFILE_KEYWORD

public static final java.lang.String COPYDBTABLETOFILE_KEYWORD

"CopyDBTableToFile"

See Also:

Constant Field Values

DELETEDBTABLERECORDS_KEYWORD

public static final java.lang.String DELETEDBTABLERECORDS_KEYWORD

"DeleteDBTableRecords"

See Also:

Constant Field Values

EXECSQLQUERY_KEYWORD

public static final java.lang.String EXECSQLQUERY_KEYWORD

"ExecSQLQuery"

See Also:

Constant Field Values

GETDBTABLECOLUMNCOUNT_KEYWORD

public static final java.lang.String GETDBTABLECOLUMNCOUNT_KEYWORD

"GetDBTableColumnCount"

See Also:

Constant Field Values

GETDBTABLEROWCOUNT_KEYWORD

public static final java.lang.String GETDBTABLEROWCOUNT_KEYWORD

"GetDBTableRowCount"

See Also:

Constant Field Values

GETDBVALUE_KEYWORD

public static final java.lang.String GETDBVALUE_KEYWORD

"GetDBValue"

See Also:

Constant Field Values

SETJDBCDRIVER_KEYWORD

public static final java.lang.String SETJDBCDRIVER_KEYWORD

"SetJdbcDriver"

See Also:

Constant Field Values

VERIFYDATABASENULLVALUE_KEYWORD

public static final java.lang.String VERIFYDATABASENULLVALUE_KEYWORD

"VerifyDatabaseNullValue"

See Also:

Constant Field Values

VERIFYDATABASEVALUE_KEYWORD

public static final java.lang.String VERIFYDATABASEVALUE_KEYWORD

"VerifyDatabaseValue"

See Also:

Constant Field Values

VERIFYDBNULLVALUE_KEYWORD

public static final java.lang.String VERIFYDBNULLVALUE_KEYWORD

"VerifyDBNullValue"

See Also:

Constant Field Values

VERIFYDBVALUE_KEYWORD

public static final java.lang.String VERIFYDBVALUE_KEYWORD

"VerifyDBValue"

See Also:

Constant Field Values

Method Detail

getInstance

public static DDDriverDatabaseCommands getInstance()

public Singleton to access class static methods via instance

copyDBTableColumnToFile

public static DriverCommand copyDBTableColumnToFile(java.lang.String aDBAlias,
                                                    java.lang.String aTableAlias,
                                                    java.lang.String dBSourceName,
                                                    java.lang.String fileOut,
                                                    java.lang.String sQLQuery,
                                                    java.lang.String directoryOut,
                                                    java.lang.String sQLStatus,
                                                    java.lang.String delimiter,
                                                    java.lang.String userID,
                                                    java.lang.String password)

 
              This routine will copy the contents of one or more DBTable column(s) to a file.
              
                 This routine will export the contents of one or more DBTable column(s) to
                 a delimeted file. If columnDelimiter is omitted, a horizontal tab is used
                 to delimit fields.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

fileOut - Optional:NO Name of the output file.

sQLQuery - Optional:NO The file will contain the results of the executed Query. The query is NOT validated by this function.

directoryOut - Optional:YES OPTIONAL parameter. If not specified the file will be stored in the default test directory

sQLStatus - Optional:YES A variable which holds the current SQL run status.

delimiter - Optional:YES Optional Delimiter to be used between columns written to file.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

copyDBTableColumnToFile

public static DriverCommand copyDBTableColumnToFile(java.lang.String[] parameters)

 
              This routine will copy the contents of one or more DBTable column(s) to a file.
              
                 This routine will export the contents of one or more DBTable column(s) to
                 a delimeted file. If columnDelimiter is omitted, a horizontal tab is used
                 to delimit fields.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
fileOut -- Optional:NO Name of the output file.
sQLQuery -- Optional:NO The file will contain the results of the executed Query. The query is NOT validated by this function.
directoryOut -- Optional:YES OPTIONAL parameter. If not specified the file will be stored in the default test directory
sQLStatus -- Optional:YES A variable which holds the current SQL run status.
delimiter -- Optional:YES Optional Delimiter to be used between columns written to file.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

copyDBTableToFile

public static DriverCommand copyDBTableToFile(java.lang.String aDBAlias,
                                              java.lang.String aTableAlias,
                                              java.lang.String dBSourceName,
                                              java.lang.String fileOut,
                                              java.lang.String dBTableName,
                                              java.lang.String columnCount,
                                              java.lang.String rowCount,
                                              java.lang.String sQLQuery,
                                              java.lang.String delimiter,
                                              java.lang.String directoryOut,
                                              java.lang.String sQLStatus,
                                              java.lang.String userID,
                                              java.lang.String password)

 
              This routine will copy the contents of a DBTable  to a file.
              
                 This routine will export the contents of a DBTable  to a delimeted file.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

fileOut - Optional:NO Name of the output file.

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

columnCount - Optional:YES If specified the output file will contain only the number of columns specified.

rowCount - Optional:YES If specified the output file will contain only the number of rows specified.

sQLQuery - Optional:YES OPTIONAL parameter. If specified, the file will contain the results of the executed Query. The query is NOT validated by this function. If this is provided, the the DBTableName must be ""

delimiter - Optional:YES OPTIONAL parameter. If not specified the default ',' seperator will be used.

directoryOut - Optional:YES OPTIONAL parameter. If not specified the file will be stored in the default test directory

sQLStatus - Optional:YES A variable which holds the current SQL run status.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

copyDBTableToFile

public static DriverCommand copyDBTableToFile(java.lang.String[] parameters)

 
              This routine will copy the contents of a DBTable  to a file.
              
                 This routine will export the contents of a DBTable  to a delimeted file.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
fileOut -- Optional:NO Name of the output file.
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
columnCount -- Optional:YES If specified the output file will contain only the number of columns specified.
rowCount -- Optional:YES If specified the output file will contain only the number of rows specified.
sQLQuery -- Optional:YES OPTIONAL parameter. If specified, the file will contain the results of the executed Query. The query is NOT validated by this function. If this is provided, the the DBTableName must be ""
delimiter -- Optional:YES OPTIONAL parameter. If not specified the default ',' seperator will be used.
directoryOut -- Optional:YES OPTIONAL parameter. If not specified the file will be stored in the default test directory
sQLStatus -- Optional:YES A variable which holds the current SQL run status.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

deleteDBTableRecords

public static DriverCommand deleteDBTableRecords(java.lang.String aDBAlias,
                                                 java.lang.String aTableAlias,
                                                 java.lang.String dBTableName,
                                                 java.lang.String dBQueryCond,
                                                 java.lang.String dBSourceName,
                                                 java.lang.String userID,
                                                 java.lang.String password,
                                                 java.lang.String sQLStatus)

 
                 Deletes records in a database table
              
                 Deletes records in a database table.
                 
                 A table name is required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:NO Expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

sQLStatus - Optional:YES SQL status code as a result of executing the query gets stored in this variable

deleteDBTableRecords

public static DriverCommand deleteDBTableRecords(java.lang.String[] parameters)

 
                 Deletes records in a database table
              
                 Deletes records in a database table.
                 
                 A table name is required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:NO Expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
sQLStatus -- Optional:YES SQL status code as a result of executing the query gets stored in this variable

execSQLQuery

public static DriverCommand execSQLQuery(java.lang.String aDBAlias,
                                         java.lang.String aTableAlias,
                                         java.lang.String dBSourceName,
                                         java.lang.String queryStr,
                                         java.lang.String sQLStatusCode,
                                         java.lang.String userID,
                                         java.lang.String password)

 
                 Executes the query provided in a queryStr on the database table.
              
                 Executes the query in a database table.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 Use this command with caution.  It doesn't return any value back other than the
                 SQL Status code.  So, remember not to use 'SELECT' command inside the queryStr.
                 It should rather be used to do an 'UPDATE', 'INSERT' or 'DELETE'.
                  
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

queryStr - Optional:NO Actual query stored in a queryStr.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

execSQLQuery

public static DriverCommand execSQLQuery(java.lang.String[] parameters)

 
                 Executes the query provided in a queryStr on the database table.
              
                 Executes the query in a database table.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 Use this command with caution.  It doesn't return any value back other than the
                 SQL Status code.  So, remember not to use 'SELECT' command inside the queryStr.
                 It should rather be used to do an 'UPDATE', 'INSERT' or 'DELETE'.
                  
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
queryStr -- Optional:NO Actual query stored in a queryStr.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

getDBTableColumnCount

public static DriverCommand getDBTableColumnCount(java.lang.String aDBAlias,
                                                  java.lang.String aTableAlias,
                                                  java.lang.String dBSourceName,
                                                  java.lang.String dBTableName,
                                                  java.lang.String columnCount,
                                                  java.lang.String sQLStatusCode,
                                                  java.lang.String userID,
                                                  java.lang.String password)

 
                 Executes the query in a specified database table and returns the total column count.
              
                 Executes the query in a specified database table and returns the total column count.
                 
                 A data source name  and Table name are required. You also have to specify a 
                 variable to get the result of the SQL and status code.  And optionally user id 
                 and password (this is because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

columnCount - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

getDBTableColumnCount

public static DriverCommand getDBTableColumnCount(java.lang.String[] parameters)

 
                 Executes the query in a specified database table and returns the total column count.
              
                 Executes the query in a specified database table and returns the total column count.
                 
                 A data source name  and Table name are required. You also have to specify a 
                 variable to get the result of the SQL and status code.  And optionally user id 
                 and password (this is because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
columnCount -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

getDBTableRowCount

public static DriverCommand getDBTableRowCount(java.lang.String aDBAlias,
                                               java.lang.String aTableAlias,
                                               java.lang.String dBSourceName,
                                               java.lang.String dBTableName,
                                               java.lang.String rowCount,
                                               java.lang.String sQLStatusCode,
                                               java.lang.String userID,
                                               java.lang.String password)

 
                 Executes the query in a database table.
              
                 Executes the query in a database table.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

rowCount - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

getDBTableRowCount

public static DriverCommand getDBTableRowCount(java.lang.String[] parameters)

 
                 Executes the query in a database table.
              
                 Executes the query in a database table.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
rowCount -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

getDBValue

public static DriverCommand getDBValue(java.lang.String aDBAlias,
                                       java.lang.String aTableAlias,
                                       java.lang.String dBSourceName,
                                       java.lang.String queryStr,
                                       java.lang.String queryResult,
                                       java.lang.String sQLStatusCode,
                                       java.lang.String userID,
                                       java.lang.String password)

 
                 Executes the query and returns the case-sensitive value as result of the execution.
              
                 Executes the query specified in the queryStr and returns the case-sensitive value
                 as result of the execution.
                 
                 To return the value, it executes a SQL query sentence using a data source to 
                 connect to the data base (using a 'SELECT').
                 
                 A queryStr and the two return variables to store the query result and SQL Status code
                 are required.  You also have to specify data source name and optionally user id and
                 password (this is because some drivers don't need a user/password).
                 
                 If the query returns more than one record, the returned value is the corresponding to the
                 first one, unless the field name be something like COUNT(*) or SUM(InvoiceTot).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

queryStr - Optional:NO Actual query stored in a queryStr.

queryResult - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

getDBValue

public static DriverCommand getDBValue(java.lang.String[] parameters)

 
                 Executes the query and returns the case-sensitive value as result of the execution.
              
                 Executes the query specified in the queryStr and returns the case-sensitive value
                 as result of the execution.
                 
                 To return the value, it executes a SQL query sentence using a data source to 
                 connect to the data base (using a 'SELECT').
                 
                 A queryStr and the two return variables to store the query result and SQL Status code
                 are required.  You also have to specify data source name and optionally user id and
                 password (this is because some drivers don't need a user/password).
                 
                 If the query returns more than one record, the returned value is the corresponding to the
                 first one, unless the field name be something like COUNT(*) or SUM(InvoiceTot).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
queryStr -- Optional:NO Actual query stored in a queryStr.
queryResult -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

setJdbcDriver

public static DriverCommand setJdbcDriver(java.lang.String driverClassName)

 
                 set Jdbc Driver
              
                 sets a JDBC driver, can be called more than once with
                 multiple drivers.
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

driverClassName - Optional:NO Name of the driver class

verifyDatabaseNullValue

public static DriverCommand verifyDatabaseNullValue(java.lang.String aDBAlias,
                                                    java.lang.String aTableAlias,
                                                    java.lang.String dBFieldName,
                                                    java.lang.String dBTableName,
                                                    java.lang.String dBQueryCond,
                                                    java.lang.String dBSourceName,
                                                    java.lang.String userID,
                                                    java.lang.String password,
                                                    java.lang.String sQLStatus)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 user id and password (the user id and password can be "" meaning not required).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

sQLStatus - Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDatabaseNullValue

public static DriverCommand verifyDatabaseNullValue(java.lang.String[] parameters)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 user id and password (the user id and password can be "" meaning not required).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
sQLStatus -- Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDatabaseValue

public static DriverCommand verifyDatabaseValue(java.lang.String aDBAlias,
                                                java.lang.String aTableAlias,
                                                java.lang.String dBFieldName,
                                                java.lang.String dBTableName,
                                                java.lang.String dBQueryCond,
                                                java.lang.String dBSourceName,
                                                java.lang.String userID,
                                                java.lang.String password,
                                                java.lang.String expectedValue,
                                                java.lang.String sQLStatus)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using a
                 data source to connect to the data base (using a 'SELECT'). 
                 
                 A table and field name are required. You also have to specify data source name,
                 user id, password, and the expected value.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:NO UserID for accessing the Datasource (if required, if not then "" must be supplied).

password - Optional:NO Password for accessing the Datasource (if required, if not then "" must be supplied).

expectedValue - Optional:NO Benchmark value to compare against retrieved DBFieldName value

sQLStatus - Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDatabaseValue

public static DriverCommand verifyDatabaseValue(java.lang.String[] parameters)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using a
                 data source to connect to the data base (using a 'SELECT'). 
                 
                 A table and field name are required. You also have to specify data source name,
                 user id, password, and the expected value.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:NO UserID for accessing the Datasource (if required, if not then "" must be supplied).
password -- Optional:NO Password for accessing the Datasource (if required, if not then "" must be supplied).
expectedValue -- Optional:NO Benchmark value to compare against retrieved DBFieldName value
sQLStatus -- Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDBNullValue

public static DriverCommand verifyDBNullValue(java.lang.String aDBAlias,
                                              java.lang.String aTableAlias,
                                              java.lang.String dBFieldName,
                                              java.lang.String dBTableName,
                                              java.lang.String dBQueryCond,
                                              java.lang.String dBSourceName,
                                              java.lang.String userID,
                                              java.lang.String password,
                                              java.lang.String sQLStatus)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 user id and password (the user id and password can be "" meaning not required).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

sQLStatus - Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDBNullValue

public static DriverCommand verifyDBNullValue(java.lang.String[] parameters)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 user id and password (the user id and password can be "" meaning not required).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
sQLStatus -- Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDBValue

public static DriverCommand verifyDBValue(java.lang.String aDBAlias,
                                          java.lang.String aTableAlias,
                                          java.lang.String dBFieldName,
                                          java.lang.String dBTableName,
                                          java.lang.String dBQueryCond,
                                          java.lang.String dBSourceName,
                                          java.lang.String userID,
                                          java.lang.String password,
                                          java.lang.String expectedValue,
                                          java.lang.String sQLStatus)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using a
                 data source to connect to the data base (using a 'SELECT').
                 
                 A table and field name are required. You also have to specify data source name,
                 user id, password, and the expected value.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:NO UserID for accessing the Datasource (if required, if not then "" must be supplied).

password - Optional:NO Password for accessing the Datasource (if required, if not then "" must be supplied).

expectedValue - Optional:NO Benchmark value to compare against retrieved DBFieldName value

sQLStatus - Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDBValue

public static DriverCommand verifyDBValue(java.lang.String[] parameters)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using a
                 data source to connect to the data base (using a 'SELECT').
                 
                 A table and field name are required. You also have to specify data source name,
                 user id, password, and the expected value.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

parameters - Optional:NO An array containing the following parameters:

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:NO UserID for accessing the Datasource (if required, if not then "" must be supplied).
password -- Optional:NO Password for accessing the Datasource (if required, if not then "" must be supplied).
expectedValue -- Optional:NO Benchmark value to compare against retrieved DBFieldName value
sQLStatus -- Optional:YES SQL status code as a result of executing the query gets stored in this variable