Interface SimpleJdbcCallOperations
- All Known Implementing Classes:
SimpleJdbcCall
public interface SimpleJdbcCallOperations
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.- Since:
- 2.5
- Author:
- Thomas Risberg, Stephane Nicoll
-
Method Summary
Modifier and TypeMethodDescriptiondeclareParameters
(SqlParameter... sqlParameters) Specify one or more parameters if desired.Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.execute
(SqlParameterSource args) Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.<T> T
executeFunction
(Class<T> returnType, Object... args) Execute the stored function and return the results obtained as an Object of the specified return type.<T> T
executeFunction
(Class<T> returnType, Map<String, ?> args) Execute the stored function and return the results obtained as an Object of the specified return type.<T> T
executeFunction
(Class<T> returnType, SqlParameterSource args) Execute the stored function and return the results obtained as an Object of the specified return type.<T> T
executeObject
(Class<T> returnType, Object... args) Execute the stored procedure and return the single out parameter as an Object of the specified return type.<T> T
executeObject
(Class<T> returnType, Map<String, ?> args) Execute the stored procedure and return the single out parameter as an Object of the specified return type.<T> T
executeObject
(Class<T> returnType, SqlParameterSource args) Execute the stored procedure and return the single out parameter as an Object of the specified return type.returningResultSet
(String parameterName, RowMapper<?> rowMapper) Used to specify when a ResultSet is returned by the stored procedure and you want it mapped by aRowMapper
.useInParameterNames
(String... inParameterNames) Not used yet.withCatalogName
(String catalogName) Optionally, specify the name of the catalog that contins the stored procedure.withFunctionName
(String functionName) Specify the procedure name to be used - this implies that we will be calling a stored function.Indicates that parameters should be bound by name.Turn off any processing of parameter meta-data information obtained via JDBC.withProcedureName
(String procedureName) Specify the procedure name to be used - this implies that we will be calling a stored procedure.Indicates the procedure's return value should be included in the results returned.withSchemaName
(String schemaName) Optionally, specify the name of the schema that contins the stored procedure.
-
Method Details
-
withProcedureName
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- Returns:
- the instance of this SimpleJdbcCall
-
withFunctionName
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- Returns:
- the instance of this SimpleJdbcCall
-
withSchemaName
Optionally, specify the name of the schema that contins the stored procedure.- Parameters:
schemaName
- the name of the schema- Returns:
- the instance of this SimpleJdbcCall
-
withCatalogName
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- Returns:
- the instance of this SimpleJdbcCall
-
withReturnValue
SimpleJdbcCallOperations withReturnValue()Indicates the procedure's return value should be included in the results returned.- Returns:
- the instance of this SimpleJdbcCall
-
declareParameters
Specify one or more parameters if desired. These parameters will be supplemented with any parameter information retrieved from the database meta-data.Note that only parameters declared as
SqlParameter
andSqlInOutParameter
will be used to provide input values. This is different from theStoredProcedure
class which - for backwards compatibility reasons - allows input values to be provided for parameters declared asSqlOutParameter
.- Parameters:
sqlParameters
- the parameters to use- Returns:
- the instance of this SimpleJdbcCall
-
useInParameterNames
Not used yet. -
returningResultSet
Used to specify when a ResultSet is returned by the stored procedure and you want it mapped by aRowMapper
. 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 parameterrowMapper
- the RowMapper implementation that will map the data returned for each row
-
withoutProcedureColumnMetaDataAccess
SimpleJdbcCallOperations withoutProcedureColumnMetaDataAccess()Turn off any processing of parameter meta-data information obtained via JDBC.- Returns:
- the instance of this SimpleJdbcCall
-
withNamedBinding
SimpleJdbcCallOperations withNamedBinding()Indicates that parameters should be bound by name.- Returns:
- the instance of this SimpleJdbcCall
- Since:
- 4.2
-
executeFunction
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 returnargs
- optional array containing the in parameter values to be used in the call. Parameter values must be provided in the same order as the parameters are defined for the stored procedure.
-
executeFunction
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 returnargs
- a Map containing the parameter values to be used in the call
-
executeFunction
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 returnargs
- the MapSqlParameterSource containing the parameter values to be used in the call
-
executeObject
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 returnargs
- optional array containing the in parameter values to be used in the call. Parameter values must be provided in the same order as the parameters are defined for the stored procedure.
-
executeObject
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 returnargs
- a Map containing the parameter values to be used in the call
-
executeObject
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 returnargs
- the MapSqlParameterSource containing the parameter values to be used in the call
-
execute
Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.- Parameters:
args
- optional array containing the in parameter values to be used in the call. Parameter values must be provided in the same order as the parameters are defined for the stored procedure.- Returns:
- a Map of output params
-
execute
Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.- Parameters:
args
- a Map containing the parameter values to be used in the call- Returns:
- a Map of output params
-
execute
Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.- Parameters:
args
- the SqlParameterSource containing the parameter values to be used in the call- Returns:
- a Map of output params
-