|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
AppConnRecordSet executeSQLStatement(java.lang.String sqlStatement) throws AppConnException, ApptrieveException
sqlStatement
- java.lang.String - The SQL statement to execute
AppConnException
- - if there is a parameter error
ApptrieveException
- - if a Host Integrator server error occursAppConnRecordSet executeSQLStatement(java.lang.String sqlStatement, int maxrows) throws AppConnException, ApptrieveException
sqlStatement
- java.lang.String - The SQL statement to executemaxrows
- Maximum number of rows to return, or zero to return all rows.
AppConnException
- - if there is a parameter error
ApptrieveException
- - if a Host Integrator server error occursColumnMetaData getColumnMetaData(java.lang.String tableName, java.lang.String columnName) throws AppConnException, ApptrieveException
tableName
- java.lang.String - Name of the table in the Host Integrator modelcolumnName
- java.lang.String - Name of the column of the table in the Host Integrator model
AppConnException
- - if there is a parameter error
ApptrieveException
- - if a Host Integrator server error occursProcedureMetaData getProcedureMetaData(java.lang.String tableName, java.lang.String procedureName) throws AppConnException, ApptrieveException
tableName
- java.lang.String - Name of the table in the Host Integrator modelprocedureName
- java.lang.String - Name of the procedure of the table in the Host Integrator model
AppConnException
- - if there is a parameter error
ApptrieveException
- - if a Host Integrator server error occursjava.util.List getTableColumns(java.lang.String tableName) throws AppConnException, ApptrieveException
tableName
- java.lang.String - Name of the table in the Host Integrator model
AppConnException
- - if there is a parameter error
ApptrieveException
- - if a Host Integrator server error occursjava.lang.String getTableDescription(java.lang.String tableName) throws AppConnException, ApptrieveException
tableName
- java.lang.String - Name of the table in the Host Integrator model
AppConnException
- - if there is a parameter error
ApptrieveException
- - if a Host Integrator server error occursjava.util.List getTableNames() throws ApptrieveException
ApptrieveException
- - if a Host Integrator server error occursjava.util.List getTableProcedures(java.lang.String tableName) throws AppConnException, ApptrieveException
tableName
- java.lang.String - Name of the table in the Host Integrator model
AppConnException
- - if there is a parameter error
ApptrieveException
- - if a Host Integrator server error occursAppConnRecordSet 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
tableName
- java.lang.String - Name of the table on which to perform the procedureprocedureName
- java.lang.String - Name of the table procedure to performdataInputValues
- java.util.Map - Set of data input column name-value pairs to usefilterValues
- java.util.Map - Set of filter column name-value pairs to usefilterIsCaseSensitive
- 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 outputmaxRows
- int - The maximum number of rows that will be returned
AppConnException
- - if there is a parameter error
ApptrieveException
- - if a Host Integrator server error occurs
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |