com.appperfect.devcommon.script
Interface IDatabaseHandler

All Known Subinterfaces:

IScriptEngine

public interface IDatabaseHandler

IDatabaseHandler is created to set the database configuration and to execute the DB operations.

Method Summary

boolean	closeResultSet(java.sql.ResultSet resultSet) To close the specified result Set.
int	executeInsertUpdateQuery(java.lang.String uniqueDatabaseId, java.lang.String query) To execute the specified query on Database to insert or update
java.sql.ResultSet	executeSelectQuery(java.lang.String uniqueDatabaseId, java.lang.String query) To execute the specified select type query on Database
java.lang.String	getLastError() To get the last error message if any error occurs during database operation
int	getNumberOfDatabaseColumns(java.lang.String uniqueDatabaseId, java.lang.String query) To get the number of columns in result set after firing the DB query
int	getNumberOfDatabaseRows(java.lang.String uniqueDatabaseId, java.lang.String query) To get the number of rows in result set after firing the DB query
java.sql.ResultSet	getResultSet(java.lang.String uniqueDatabaseId, java.lang.String query) To execute the specified query on Database
java.lang.Object	getValueFromDatabase(java.lang.String uniqueDatabaseId, java.lang.String query, int row, int column) To get the value from the result set at specified row and column after firing the DB query
boolean	isDatabaseConnectionValid(java.lang.String uniqueDatabaseId) To check if database connection specified by uniqueDatabaseId is valid
java.lang.String	setDatabaseConnection(java.lang.String uniqueDatabaseId, java.lang.String connectionURL, java.lang.String userName, java.lang.String password, java.lang.String driverClass, java.lang.String classPath) To register or configure a DataBase connection with TestStudio.

Method Detail

closeResultSet

boolean closeResultSet(java.sql.ResultSet resultSet)

To close the specified result Set.

Parameters:

resultSet - resultSet to close

Returns:

true if successful, false otherwise

executeInsertUpdateQuery

int executeInsertUpdateQuery(java.lang.String uniqueDatabaseId,
                             java.lang.String query)

To execute the specified query on Database to insert or update

Parameters:

uniqueDatabaseId - unique id referring to the database configuration

query - db query to execute

Returns:

the number of rows updated or inserted

executeSelectQuery

java.sql.ResultSet executeSelectQuery(java.lang.String uniqueDatabaseId,
                                      java.lang.String query)

To execute the specified select type query on Database

Parameters:

uniqueDatabaseId - unique id referring to the database configuration

query - select query to execute

Returns:

ResultSet object

getLastError

java.lang.String getLastError()

To get the last error message if any error occurs during database operation

Returns:

the last error message

getNumberOfDatabaseColumns

int getNumberOfDatabaseColumns(java.lang.String uniqueDatabaseId,
                               java.lang.String query)

To get the number of columns in result set after firing the DB query

Parameters:

uniqueDatabaseId - unique id referring to the database configuration

query - select type query used to fetch values from DB

Returns:

the number of columns in result set after firing the DB query

getNumberOfDatabaseRows

int getNumberOfDatabaseRows(java.lang.String uniqueDatabaseId,
                            java.lang.String query)

To get the number of rows in result set after firing the DB query

Parameters:

uniqueDatabaseId - unique id referring to the database configuration

query - select type query used to fetch values from DB

Returns:

the number of rows in result set after firing the DB query

getResultSet

java.sql.ResultSet getResultSet(java.lang.String uniqueDatabaseId,
                                java.lang.String query)

To execute the specified query on Database

Parameters:

uniqueDatabaseId - unique id referring to the database configuration

query - query to execute

Returns:

ResultSet object

getValueFromDatabase

java.lang.Object getValueFromDatabase(java.lang.String uniqueDatabaseId,
                                      java.lang.String query,
                                      int row,
                                      int column)

To get the value from the result set at specified row and column after firing the DB query

Parameters:

uniqueDatabaseId - unique id referring to the database configuration

query - select type query used to fetch values from DB

row - row index in the result set

column - column index in the result set

Returns:

Object value at specified index

isDatabaseConnectionValid

boolean isDatabaseConnectionValid(java.lang.String uniqueDatabaseId)

To check if database connection specified by uniqueDatabaseId is valid

Parameters:

uniqueDatabaseId - unique id referring to the database configuration to test

Returns:

true if connection is valid, false otherwise

setDatabaseConnection

java.lang.String setDatabaseConnection(java.lang.String uniqueDatabaseId,
                                       java.lang.String connectionURL,
                                       java.lang.String userName,
                                       java.lang.String password,
                                       java.lang.String driverClass,
                                       java.lang.String classPath)

To register or configure a DataBase connection with TestStudio.

Parameters:

uniqueDatabaseId - unique id which should be allocated for each database configuration. This id is used to refer to the concerned DB connection while firing the queries or doing any DB specific action.

connectionURL - connection url for the database

userName - user name for accessing Database

password - password for accessing Database

driverClass - class name of the JDBC driver used to access the database

classPath - class path for the driver class

Returns:

database name for which the connection settings were configured