com.wrq.apptrieve.appconn
Interface AppConnTable

All Known Implementing Classes:
AppConnRejuvenationSession, AppConnSession

public interface AppConnTable

This interface defines the methods that allow access to the tables and procedures defined in a Host Integrator model.


Method Summary
 AppConnRecordSet executeSQLStatement(java.lang.String sqlStatement)
          Executes an SQL statement on a table defined in the model.
 AppConnRecordSet executeSQLStatement(java.lang.String sqlStatement, int maxrows)
          Executes an SQL statement on a table defined in the model.
 ColumnMetaData getColumnMetaData(java.lang.String tableName, java.lang.String columnName)
          Gets metadata associated with a table column.
 ProcedureMetaData getProcedureMetaData(java.lang.String tableName, java.lang.String procedureName)
          Gets metadata associated with a table procedure.
 java.util.List getTableColumns(java.lang.String tableName)
          Gets the column names of a table in the Host Integrator model.
 java.lang.String getTableDescription(java.lang.String tableName)
          Gets the description for a table in the Host Integrator model.
 java.util.List getTableNames()
          Gets the table names in the Host Integrator model.
 java.util.List getTableProcedures(java.lang.String tableName)
          Gets the procedures names for a table in the Host Integrator model.
 AppConnRecordSet performTableProcedure(java.lang.String tableName, java.lang.String procedureName, java.util.Map dataInputValues, java.util.Map filterValues, boolean filterIsCaseSensitive, java.util.List outputColumnNames, int maxRows)
          Performs a procedure on a table defined in the model.
 

Method Detail

executeSQLStatement

AppConnRecordSet executeSQLStatement(java.lang.String sqlStatement)
                                     throws AppConnException,
                                            ApptrieveException
Executes an SQL statement on a table defined in the model.

Parameters:
sqlStatement - java.lang.String - The SQL statement to execute
Returns:
com.wrq.apptrieve.appconn.AppConnRecordSet - the results of the query execution. If no data are retrieved as the result of executing the SQL statement, the method returns an AppConnRecordSet object containing no records.
Throws:
AppConnException - - if there is a parameter error
ApptrieveException - - if a Host Integrator server error occurs

executeSQLStatement

AppConnRecordSet executeSQLStatement(java.lang.String sqlStatement,
                                     int maxrows)
                                     throws AppConnException,
                                            ApptrieveException
Executes an SQL statement on a table defined in the model.

Parameters:
sqlStatement - java.lang.String - The SQL statement to execute
maxrows - Maximum number of rows to return, or zero to return all rows.
Returns:
com.wrq.apptrieve.appconn.AppConnRecordSet - the results of the query execution. If no data are retrieved as the result of executing the SQL statement, the method returns an AppConnRecordSet object containing no records.
Throws:
AppConnException - - if there is a parameter error
ApptrieveException - - if a Host Integrator server error occurs

getColumnMetaData

ColumnMetaData getColumnMetaData(java.lang.String tableName,
                                 java.lang.String columnName)
                                 throws AppConnException,
                                        ApptrieveException
Gets metadata associated with a table column.

Parameters:
tableName - java.lang.String - Name of the table in the Host Integrator model
columnName - java.lang.String - Name of the column of the table in the Host Integrator model
Returns:
com.wrq.apptrieve.ColumnMetaData - Column metadata object
Throws:
AppConnException - - if there is a parameter error
ApptrieveException - - if a Host Integrator server error occurs

getProcedureMetaData

ProcedureMetaData getProcedureMetaData(java.lang.String tableName,
                                       java.lang.String procedureName)
                                       throws AppConnException,
                                              ApptrieveException
Gets metadata associated with a table procedure.

Parameters:
tableName - java.lang.String - Name of the table in the Host Integrator model
procedureName - java.lang.String - Name of the procedure of the table in the Host Integrator model
Returns:
com.wrq.apptrieve.ProcedureMetaData - Procedure metadata object
Throws:
AppConnException - - if there is a parameter error
ApptrieveException - - if a Host Integrator server error occurs

getTableColumns

java.util.List getTableColumns(java.lang.String tableName)
                               throws AppConnException,
                                      ApptrieveException
Gets the column names of a table in the Host Integrator model.

Parameters:
tableName - java.lang.String - Name of the table in the Host Integrator model
Returns:
java.util.List - Column names for the table (Strings)
Throws:
AppConnException - - if there is a parameter error
ApptrieveException - - if a Host Integrator server error occurs

getTableDescription

java.lang.String getTableDescription(java.lang.String tableName)
                                     throws AppConnException,
                                            ApptrieveException
Gets the description for a table in the Host Integrator model.

Parameters:
tableName - java.lang.String - Name of the table in the Host Integrator model
Returns:
java.lang.String - The description for the table
Throws:
AppConnException - - if there is a parameter error
ApptrieveException - - if a Host Integrator server error occurs

getTableNames

java.util.List getTableNames()
                             throws ApptrieveException
Gets the table names in the Host Integrator model.

Returns:
java.util.List - a List of Strings, one for each table name of the model
Throws:
ApptrieveException - - if a Host Integrator server error occurs

getTableProcedures

java.util.List getTableProcedures(java.lang.String tableName)
                                  throws AppConnException,
                                         ApptrieveException
Gets the procedures names for a table in the Host Integrator model.

Parameters:
tableName - java.lang.String - Name of the table in the Host Integrator model
Returns:
java.util.List - a List of Strings, one for each procedure name of the specified table
Throws:
AppConnException - - if there is a parameter error
ApptrieveException - - if a Host Integrator server error occurs

performTableProcedure

AppConnRecordSet performTableProcedure(java.lang.String tableName,
                                       java.lang.String procedureName,
                                       java.util.Map dataInputValues,
                                       java.util.Map filterValues,
                                       boolean filterIsCaseSensitive,
                                       java.util.List outputColumnNames,
                                       int maxRows)
                                       throws AppConnException,
                                              ApptrieveException
Performs a procedure on a table defined in the model.

Parameters:
tableName - java.lang.String - Name of the table on which to perform the procedure
procedureName - java.lang.String - Name of the table procedure to perform
dataInputValues - java.util.Map - Set of data input column name-value pairs to use
filterValues - java.util.Map - Set of filter column name-value pairs to use
filterIsCaseSensitive - boolean - set to true to make the filter comparison case sensitive, false for case insensitive.
outputColumnNames - java.util.List - List of the table's column names to return as output
maxRows - int - The maximum number of rows that will be returned
Returns:
com.wrq.apptrieve.appconn.AppConnRecordSet - the result of performing the table procedure. If no data are retrieved as the result of performing the table procedure, the method returns an AppConnRecordSet object containing no records.
Throws:
AppConnException - - if there is a parameter error
ApptrieveException - - if a Host Integrator server error occurs