org.safs.model.commands

Class DatabaseFunctions

java.lang.Object

org.safs.model.commands.DatabaseFunctions

public class DatabaseFunctions
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	EXECSQLCOMMIT_KEYWORD "ExecSQLCommit"
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	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 ComponentFunction	copyDBTableColumnToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) This routine will copy the contents of one or more DBTable column(s) to a file.
static ComponentFunction	copyDBTableColumnToFile(java.lang.String winname, java.lang.String compname, 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, java.lang.String prompt) This routine will copy the contents of one or more DBTable column(s) to a file.
static ComponentFunction	copyDBTableToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) This routine will copy the contents of a DBTable to a file.
static ComponentFunction	copyDBTableToFile(java.lang.String winname, java.lang.String compname, 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, java.lang.String prompt) This routine will copy the contents of a DBTable to a file.
static ComponentFunction	deleteDBTableRecords(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Deletes records in a database table Deletes records in a database table.
static ComponentFunction	deleteDBTableRecords(java.lang.String winname, java.lang.String compname, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String prompt) Deletes records in a database table Deletes records in a database table.
static ComponentFunction	execSQLCommit(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) This routine will commit the pending queries on the database.
static ComponentFunction	execSQLCommit(java.lang.String winname, java.lang.String compname, java.lang.String dBSourceName, java.lang.String sQLStatus, java.lang.String userID, java.lang.String password) This routine will commit the pending queries on the database.
static ComponentFunction	execSQLQuery(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Executes the query provided in a ^queryStr on the database table.
static ComponentFunction	execSQLQuery(java.lang.String winname, java.lang.String compname, java.lang.String dBSourceName, java.lang.String queryStr, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query provided in a ^queryStr on the database table.
static ComponentFunction	getDBTableColumnCount(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Executes the query in a specified database table and returns the total column count.
static ComponentFunction	getDBTableColumnCount(java.lang.String winname, java.lang.String compname, java.lang.String dBSourceName, java.lang.String dBTableName, java.lang.String columnCount, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query in a specified database table and returns the total column count.
static ComponentFunction	getDBTableRowCount(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Executes the query in a database table.
static ComponentFunction	getDBTableRowCount(java.lang.String winname, java.lang.String compname, java.lang.String dBSourceName, java.lang.String dBTableName, java.lang.String rowCount, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query in a database table.
static ComponentFunction	getDBValue(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Executes the query and returns the case-sensitive value as result of the execution.
static ComponentFunction	getDBValue(java.lang.String winname, java.lang.String compname, java.lang.String dBSourceName, java.lang.String queryStr, java.lang.String queryResult, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password, java.lang.String prompt) Executes the query and returns the case-sensitive value as result of the execution.
static DatabaseFunctions	getInstance() public Singleton to access class static methods via instance
static ComponentFunction	verifyDatabaseNullValue(java.lang.String winname, java.lang.String compname, 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 ComponentFunction	verifyDatabaseNullValue(java.lang.String winname, java.lang.String compname, 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 prompt) 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 ComponentFunction	verifyDatabaseValue(java.lang.String winname, java.lang.String compname, 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 ComponentFunction	verifyDatabaseValue(java.lang.String winname, java.lang.String compname, 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 prompt) 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 ComponentFunction	verifyDBNullValue(java.lang.String winname, java.lang.String compname, 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 ComponentFunction	verifyDBNullValue(java.lang.String winname, java.lang.String compname, 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 prompt) 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 ComponentFunction	verifyDBValue(java.lang.String winname, java.lang.String compname, 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 ComponentFunction	verifyDBValue(java.lang.String winname, java.lang.String compname, 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 prompt, java.lang.String expectedValue) 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

EXECSQLCOMMIT_KEYWORD

public static final java.lang.String EXECSQLCOMMIT_KEYWORD

"ExecSQLCommit"

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

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 DatabaseFunctions getInstance()

public Singleton to access class static methods via instance

copyDBTableColumnToFile

public static ComponentFunction copyDBTableColumnToFile(java.lang.String winname,
                                                        java.lang.String compname,
                                                        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,
                                                        java.lang.String prompt)

 
              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 [DSN] 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).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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 under the project "Datapool\Test\" directory.

sQLStatus - Optional:NO 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).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

copyDBTableColumnToFile

public static ComponentFunction copyDBTableColumnToFile(java.lang.String winname,
                                                        java.lang.String compname,
                                                        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 [DSN] 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).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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 under the project "Datapool\Test\" directory.
sQLStatus -- Optional:NO 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).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

copyDBTableToFile

public static ComponentFunction copyDBTableToFile(java.lang.String winname,
                                                  java.lang.String compname,
                                                  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,
                                                  java.lang.String prompt)

 
              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 [DSN] 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).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.  If no output directory is specified, the result file
                 get saved under "Datapool\Test\".
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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.

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 under the project "Datapool\Test\" directory.

sQLStatus - Optional:NO 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).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

copyDBTableToFile

public static ComponentFunction copyDBTableToFile(java.lang.String winname,
                                                  java.lang.String compname,
                                                  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 [DSN] 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).
                 
                 To do: if user id and/or password are not specified, don't include them in the
                 connection string. This would allow the possibility to specify them in the 
                 data source definition.  If no output directory is specified, the result file
                 get saved under "Datapool\Test\".
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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.
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 under the project "Datapool\Test\" directory.
sQLStatus -- Optional:NO 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).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

deleteDBTableRecords

public static ComponentFunction deleteDBTableRecords(java.lang.String winname,
                                                     java.lang.String compname,
                                                     java.lang.String dBTableName,
                                                     java.lang.String dBQueryCond,
                                                     java.lang.String dBSourceName,
                                                     java.lang.String userID,
                                                     java.lang.String password,
                                                     java.lang.String prompt)

 
                 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).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

dBQueryCond - Optional:YES 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).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

deleteDBTableRecords

public static ComponentFunction deleteDBTableRecords(java.lang.String winname,
                                                     java.lang.String compname,
                                                     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).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:YES 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).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

execSQLCommit

public static ComponentFunction execSQLCommit(java.lang.String winname,
                                              java.lang.String compname,
                                              java.lang.String dBSourceName,
                                              java.lang.String sQLStatus,
                                              java.lang.String userID,
                                              java.lang.String password)

 
              This routine will commit the pending queries on the database.
              
                 When ExecSQLQuery is used with the autoCommit option turned off, queries will be
                 not be auto-committed as is the default with JDBC.  In this way, you can use
                 multiple ExecSQLQuery statements, but then use ExecSQLCommit to commit all of
                 the queries at once.

                 This can be useful if your program is using a special process that requires
                 committing all queries at one time.
                 
                 A data source name [DSN] 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

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

sQLStatus - Optional:NO 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).

execSQLCommit

public static ComponentFunction execSQLCommit(java.lang.String winname,
                                              java.lang.String compname,
                                              java.lang.String[] parameters)

 
              This routine will commit the pending queries on the database.
              
                 When ExecSQLQuery is used with the autoCommit option turned off, queries will be
                 not be auto-committed as is the default with JDBC.  In this way, you can use
                 multiple ExecSQLQuery statements, but then use ExecSQLCommit to commit all of
                 the queries at once.

                 This can be useful if your program is using a special process that requires
                 committing all queries at one time.
                 
                 A data source name [DSN] 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

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
sQLStatus -- Optional:NO 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).

execSQLQuery

public static ComponentFunction execSQLQuery(java.lang.String winname,
                                             java.lang.String compname,
                                             java.lang.String dBSourceName,
                                             java.lang.String queryStr,
                                             java.lang.String sQLStatusCode,
                                             java.lang.String userID,
                                             java.lang.String password,
                                             java.lang.String prompt)

 
                 Executes the query provided in a ^queryStr on the database table.
              
                 Executes the query in a database table.
                 
                 A data source name [DSN] 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 use Select command inside the queryStr.
                 It cab be use to update Table. or reset some flag.
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                  
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

execSQLQuery

public static ComponentFunction execSQLQuery(java.lang.String winname,
                                             java.lang.String compname,
                                             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 [DSN] 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 use Select command inside the queryStr.
                 It cab be use to update Table. or reset some flag.
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                  
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableColumnCount

public static ComponentFunction getDBTableColumnCount(java.lang.String winname,
                                                      java.lang.String compname,
                                                      java.lang.String dBSourceName,
                                                      java.lang.String dBTableName,
                                                      java.lang.String columnCount,
                                                      java.lang.String sQLStatusCode,
                                                      java.lang.String userID,
                                                      java.lang.String password,
                                                      java.lang.String prompt)

 
                 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 [DSN] 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).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableColumnCount

public static ComponentFunction getDBTableColumnCount(java.lang.String winname,
                                                      java.lang.String compname,
                                                      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 [DSN] 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).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition.
                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableRowCount

public static ComponentFunction getDBTableRowCount(java.lang.String winname,
                                                   java.lang.String compname,
                                                   java.lang.String dBSourceName,
                                                   java.lang.String dBTableName,
                                                   java.lang.String rowCount,
                                                   java.lang.String sQLStatusCode,
                                                   java.lang.String userID,
                                                   java.lang.String password,
                                                   java.lang.String prompt)

 
                 Executes the query in a database table.
              
                 Executes the query in a database table.
                 
                 A data source name [DSN] 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).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition. 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBTableRowCount

public static ComponentFunction getDBTableRowCount(java.lang.String winname,
                                                   java.lang.String compname,
                                                   java.lang.String[] parameters)

 
                 Executes the query in a database table.
              
                 Executes the query in a database table.
                 
                 A data source name [DSN] 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).
                 
                 To do: if user id and/or password are not specified, don't include them in the 
                 connection string. This would allow the possibility to specify them in the data
                 source definition. 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBValue

public static ComponentFunction getDBValue(java.lang.String winname,
                                           java.lang.String compname,
                                           java.lang.String dBSourceName,
                                           java.lang.String queryStr,
                                           java.lang.String queryResult,
                                           java.lang.String sQLStatusCode,
                                           java.lang.String userID,
                                           java.lang.String password,
                                           java.lang.String prompt)

 
                 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 an ODBC data source to 
                 connect to the data base.
                 
                 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).
                 
                 To do: if user id and/or password are not specified, don't include them in the connection
                 string. This would allow the possibility to specify them in the data source definition.
                 
                 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

getDBValue

public static ComponentFunction getDBValue(java.lang.String winname,
                                           java.lang.String compname,
                                           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 an ODBC data source to 
                 connect to the data base.
                 
                 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).
                 
                 To do: if user id and/or password are not specified, don't include them in the connection
                 string. This would allow the possibility to specify them in the data source definition.
                 
                 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseNullValue

public static ComponentFunction verifyDatabaseNullValue(java.lang.String winname,
                                                        java.lang.String compname,
                                                        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 prompt)

 
                 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,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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:YES 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).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseNullValue

public static ComponentFunction verifyDatabaseNullValue(java.lang.String winname,
                                                        java.lang.String compname,
                                                        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,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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:YES 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).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseValue

public static ComponentFunction verifyDatabaseValue(java.lang.String winname,
                                                    java.lang.String compname,
                                                    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 prompt)

 
                 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 an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name 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).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 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, usually it is. 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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:YES 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).

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

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDatabaseValue

public static ComponentFunction verifyDatabaseValue(java.lang.String winname,
                                                    java.lang.String compname,
                                                    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 an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name 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).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 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, usually it is. 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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:YES 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).
expectedValue -- Optional:NO Benchmark value to compare against retrieved DBFieldName value
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDBNullValue

public static ComponentFunction verifyDBNullValue(java.lang.String winname,
                                                  java.lang.String compname,
                                                  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 prompt)

 
                 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,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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:YES 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).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDBNullValue

public static ComponentFunction verifyDBNullValue(java.lang.String winname,
                                                  java.lang.String compname,
                                                  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,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 A query condition can be included, usually it is. 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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:YES 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).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

verifyDBValue

public static ComponentFunction verifyDBValue(java.lang.String winname,
                                              java.lang.String compname,
                                              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 prompt,
                                              java.lang.String expectedValue)

 
                 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 an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name 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).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 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, usually it is. 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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:YES 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).

prompt - Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

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

verifyDBValue

public static ComponentFunction verifyDBValue(java.lang.String winname,
                                              java.lang.String compname,
                                              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 an ODBC 
                 data source to connect to the data base. 
                 
                 A table and field name 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).
                 
                 To do: if user id and/or password are not specified, don't include
                 them in the connection string. This would allow the possibility
                 to specify them in the data source definition.
                 
                 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, usually it is. 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 Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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:YES 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).
prompt -- Optional:YES Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.
expectedValue -- Optional:NO Benchmark value to compare against retrieved DBFieldName value