| org.springframework.jdbc.core.simple.SimpleJdbcCallOperations
All known Subclasses: org.springframework.jdbc.core.simple.SimpleJdbcCall,
| SimpleJdbcCallOperations | | public interface SimpleJdbcCallOperations (Code) | | Interface specifying the API for a Simple JDBC Call implemented by
SimpleJdbcCall .
This interface is not often used directly, but provides the
option to enhance testability, as it can easily be mocked or stubbed.
author:
Thomas Risberg
since:
2.5 |
| Method Summary | |
| SimpleJdbcCallOperations | declareParameters(SqlParameter... sqlParameters)
Specify one or more parameters if desired. | | Map<String, Object> | execute()
Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.. | | Map<String, Object> | execute(Map<String, Object> args)
Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations..
Parameters:
args - Map containing the parameter values to be used in the call. | | Map<String, Object> | execute(SqlParameterSource args)
Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations..
Parameters:
args - SqlParameterSource containing the parameter values to be used in the call. | | T | executeFunction(Class<T> returnType, Map args)
Execute the stored function and return the results obtained as an Object of the specified return type. | | T | executeFunction(Class<T> returnType, MapSqlParameterSource args)
Execute the stored function and return the results obtained as an Object of the specified return type. | | T | executeObject(Class<T> returnType, Map args)
Execute the stored procedure and return the single out parameter as an Object of the specified return type. | | T | executeObject(Class<T> returnType, MapSqlParameterSource args)
Execute the stored procedure and return the single out parameter as an Object of the specified return type. | | SimpleJdbcCallOperations | returningResultSet(String parameterName, ParameterizedRowMapper rowMapper)
Used to specify when a ResultSet is returned by the stored procedure and you want it mapped
by a RowMapper. | | SimpleJdbcCallOperations | useInParameterNames(String... inParameterNames)
| | SimpleJdbcCallOperations | withCatalogName(String catalogName)
Optionally, specify the name of the catalog that contins the stored procedure. | | SimpleJdbcCallOperations | withFunctionName(String functionName)
Specify the procedure name to be used - this implies that we will be calling a stored function. | | SimpleJdbcCallOperations | withProcedureName(String procedureName)
Specify the procedure name to be used - this implies that we will be calling a stored procedure. | | SimpleJdbcCallOperations | withReturnValue()
Indicates the procedure's return value should be included in the results returned. | | SimpleJdbcCallOperations | withSchemaName(String schemaName)
Optionally, specify the name of the schema that contins the stored procedure. | | SimpleJdbcCallOperations | withoutProcedureColumnMetaDataAccess()
Turn off any processing of parameter meta data information obtained via JDBC. |
| declareParameters | | SimpleJdbcCallOperations declareParameters(SqlParameter... sqlParameters)(Code) | | Specify one or more parameters if desired. These parameters will be supplemented with any
parameter information retrieved from the database meta data.
Parameters:
sqlParameters - the parameters to use the instance of this SimpleJdbcCall |
| execute | | Map<String, Object> execute()(Code) | | Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations..
map of output params. |
| execute | | Map<String, Object> execute(Map<String, Object> args)(Code) | | Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations..
Parameters:
args - Map containing the parameter values to be used in the call. map of output params. |
| execute | | Map<String, Object> execute(SqlParameterSource args)(Code) | | Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations..
Parameters:
args - SqlParameterSource containing the parameter values to be used in the call. map of output params. |
| executeFunction | | T executeFunction(Class<T> returnType, Map args)(Code) | | Execute the stored function and return the results obtained as an Object of the specified return type.
Parameters:
returnType - the type of the value to return
Parameters:
args - Map containing the parameter values to be used in the call. |
| executeFunction | | T executeFunction(Class<T> returnType, MapSqlParameterSource args)(Code) | | Execute the stored function and return the results obtained as an Object of the specified return type.
Parameters:
returnType - the type of the value to return
Parameters:
args - MapSqlParameterSource containing the parameter values to be used in the call. |
| executeObject | | T executeObject(Class<T> returnType, Map args)(Code) | | Execute the stored procedure and return the single out parameter as an Object of the specified return type.
In the case where there are multiple out parameters, the first one is returned and additional out parameters
are ignored.
Parameters:
returnType - the type of the value to return
Parameters:
args - Map containing the parameter values to be used in the call. |
| executeObject | | T executeObject(Class<T> returnType, MapSqlParameterSource args)(Code) | | Execute the stored procedure and return the single out parameter as an Object of the specified return type.
In the case where there are multiple out parameters, the first one is returned and additional out parameters
are ignored.
Parameters:
returnType - the type of the value to return
Parameters:
args - MapSqlParameterSource containing the parameter values to be used in the call. |
| returningResultSet | | SimpleJdbcCallOperations returningResultSet(String parameterName, ParameterizedRowMapper rowMapper)(Code) | | Used to specify when a ResultSet is returned by the stored procedure and you want it mapped
by a RowMapper. The results will be returned using the parameter name specified. Multiple
ResultSets must be declared in the correct order. If the database you are using uses ref cursors
then the name specified must match the name of the parameter declared for the procedure in the
database.
Parameters:
parameterName - the name of the returned results and/or the name of the ref cursor parameter
Parameters:
rowMapper - the RowMapper implementation that will map the data returned for each row |
| withCatalogName | | SimpleJdbcCallOperations withCatalogName(String catalogName)(Code) | | Optionally, specify the name of the catalog that contins the stored procedure.
To provide consistency with the Oracle DatabaseMetaData, this is used to specify the package name if
the procedure is declared as part of a package.
Parameters:
catalogName - the catalog or package name the instance of this SimpleJdbcCall |
| withFunctionName | | SimpleJdbcCallOperations withFunctionName(String functionName)(Code) | | Specify the procedure name to be used - this implies that we will be calling a stored function.
Parameters:
functionName - the name of the stored function the instance of this SimpleJdbcCall |
| withProcedureName | | SimpleJdbcCallOperations withProcedureName(String procedureName)(Code) | | Specify the procedure name to be used - this implies that we will be calling a stored procedure.
Parameters:
procedureName - the name of the stored procedure the instance of this SimpleJdbcCall |
| withReturnValue | | SimpleJdbcCallOperations withReturnValue()(Code) | | Indicates the procedure's return value should be included in the results returned.
the instance of this SimpleJdbcCall |
| withSchemaName | | SimpleJdbcCallOperations withSchemaName(String schemaName)(Code) | | Optionally, specify the name of the schema that contins the stored procedure.
Parameters:
schemaName - the name of the schema the instance of this SimpleJdbcCall |
| withoutProcedureColumnMetaDataAccess | | SimpleJdbcCallOperations withoutProcedureColumnMetaDataAccess()(Code) | | Turn off any processing of parameter meta data information obtained via JDBC.
the instance of this SimpleJdbcCall |
|
|