Constructor Detail

StoredProcedureCall

Method Detail

addNamedArgument

PUBLIC:
Define the argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterAndArgumentFieldName is the name of the procedure argument expected,
and is the field or argument name to be used to pass to the procedure.
These names are assumed to be the same, if not this method can be called with two arguments.

addNamedArgument

PUBLIC:
Define the argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
If these names are the same (as they normally are) this method can be called with a single argument.

addNamedArgumentValue

PUBLIC:
Define the argument to the stored procedure and the value to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentValue is the value of the argument to be used to pass to the procedure.

addNamedArgument

PUBLIC:
Define the input argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the user.
The type is the type of Java class for the field, and is dependent on the type required by the procedure. This is used
to set the type in case null is passed in.

addNamedArgument

PUBLIC:
Define the input argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the user.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type required by the procedure.

addNamedArgument

PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type required by the procedure.
The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.

addNamedArgument

PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type required by the procedure.
The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.
The javaType is the mapped Class that has an ObjectRelationalDataTypeDescriptor for the ARRAY
or STRUCT type typeName

PUBLIC:
Define the inout argument to the stored procedure and the field/argument name to be substituted for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
The type is the JDBC type code, this is dependent on the type required by the procedure.
The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.
The javaType is the mapped Class that has an ObjectRelationalDataTypeDescriptor for the ARRAY
or STRUCT type typeName
The nestedType is a DatabaseField with type information set to match the VARRAYs object types

addNamedArgument

PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type required by the procedure.
The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.
The javaType is the name of the mapped Class that has an ObjectRelationalDataTypeDescriptor
for the ARRAY or STRUCT type typeName

PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type required by the procedure.
The typeName is the JDBC type name, as required for STRUCT and ARRAY types.
The nestedType is a DatabaseField with type information set to match the VARRAYs object types

addNamedInOutputArgument

PUBLIC:
Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
The procedureParameterAndArgumentFieldName is the name of the procedure argument expected,
the field or argument name to be used to pass to the procedure and,
the field or argument name to be used is the result of the output row.

addNamedInOutputArgument

PUBLIC:
Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure and
is the result of the output row.

addNamedInOutputArgument

PUBLIC:
Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure and
is the result of the output row.
The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

addNamedInOutputArgument

PUBLIC:
Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
The procedureParameterName is the name of the procedure argument expected.
The inArgumentFieldName is the field or argument name to be used to pass to the procedure.
The outArgumentFieldName is the field or argument name to be used is the result of the output row.
If these names are the same (as they normally are) this method can be called with a single argument.
The type the Java class desired back from the procedure, if a struct is returned and the class has an ObjectRelationalDataTypeDescriptor defined .

addNamedInOutputArgument

PUBLIC:
Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
The procedureParameterName is the name of the procedure argument expected.
The inArgumentFieldName is the field or argument name to be used to pass to the procedure.
The outArgumentFieldName is the field or argument name to be used is the result of the output row.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this dependent on the type returned from the procedure.

addNamedInOutputArgument

PUBLIC:
Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
The procedureParameterName is the name of the procedure argument expected.
The inArgumentFieldName is the field or argument name to be used to pass to the procedure.
The outArgumentFieldName is the field or argument name to be used is the result of the output row.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.

PUBLIC:
Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
The procedureParameterName is the name of the procedure argument expected.
The inArgumentFieldName is the field or argument name to be used to pass to the procedure.
The outArgumentFieldName is the field or argument name to be used is the result of the output row.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for STRUCT and ARRAY types.
The classType is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

PUBLIC:
Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
The procedureParameterName is the name of the procedure argument expected.
The inArgumentFieldName is the field or argument name to be used to pass to the procedure.
The outArgumentFieldName is the field or argument name to be used is the result of the output row.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY types.
The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible.
The nestedType is a DatabaseField with type information set to match the VARRAYs object types

addNamedInOutputArgumentValue

PUBLIC:
Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
The procedureParameterName is the name of the procedure argument expected.
The inArgumentValue is the value of the argument to be used to pass to the procedure.
The outArgumentFieldName is the field or argument name to be used is the result of the output row.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

addNamedOutputArgument

PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterAndArgumentFieldName is the name of the procedure argument expected,
and is the field or argument name to be used to pass to the procedure.
These names are assumed to be the same, if not this method can be called with two arguments.

addNamedOutputArgument

PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
If these names are the same (as they normally are) this method can be called with a single argument.

addNamedOutputArgument

PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

addNamedOutputArgument

PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type returned from the procedure.

addNamedOutputArgument

PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.

addNamedOutputArgument

PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used is the result of the output row.
The jdbcType is the JDBC type code, this dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY and STRUCT types.
The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible.

PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it.
The procedureParameterName is the name of the procedure argument expected.
The argumentFieldName is the field or argument name to be used is the result of the output row.
The jdbcType is the JDBC type code, this dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY and STRUCT types.
The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible.
The nestedType is a DatabaseField with type information set to match the VARRAYs object types

addUnamedArgument

public void addUnamedArgument(java.lang.String argumentFieldName)

PUBLIC:
Define the field/argument name to be substitute for the index argument.
This method is used if the procedure is not named and the order is explicit, names must be added in the correct order.
The argumentFieldName is the field or argument name to be used to pass to the procedure.

addUnamedArgumentValue

public void addUnamedArgumentValue(java.lang.Object argumentValue)

PUBLIC:
Define the argument to the stored procedure for the index argument.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The argumentValue is the value of the argument to be used to pass to the procedure.

addUnamedArgument

PUBLIC:
Define the argument to the stored procedure for the index argument.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The argumentFieldName is the field or argument name to be used to pass to the user.
The type is the type of Java class for the field, and is dependent on the type required by the procedure. This is used
to set the type in case null is passed in.

addUnamedArgument

PUBLIC:
Define the argument to the stored procedure for the index argument.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The argumentFieldName is the field or argument name to be used to pass to the user.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type required by the procedure.

addUnamedArgument

PUBLIC:
Define the argument to the stored procedure for the index argument.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type required by the procedure.
The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.

addUnamedArgument

PUBLIC:
Define the argument to the stored procedure for the index argument.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type required by the procedure.
The typeName is the JDBC type name, as required for STRUCT and ARRAY types.
The nestedType is a DatabaseField with type information set to match the VARRAYs object types

addUnamedInOutputArgument

PUBLIC:
Define the argument to the stored procedure for the index argument.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The inArgumentFieldName is the field name of the argument to be used to pass to the procedure.
The outArgumentFieldName is the field or argument name to be used is the result of the output row.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

addUnamedInOutputArgument

PUBLIC:
Define the argument to the stored procedure for the index argument.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The inArgumentFieldName is the field name of the argument to be used to pass to the procedure.
The outArgumentFieldName is the field or argument name to be used is the result of the output row.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type returned from the procedure.

addUnamedInOutputArgument

PUBLIC:
Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The inArgumentFieldName is the field name of the argument to be used to pass to the procedure.
The outArgumentFieldName is the field or argument name to be used is the result of the output row.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this is dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.

addUnamedInOutputArgument

PUBLIC:
Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The argumentFieldName is the field name of the argument to be used to pass to the procedure
and to be used is the result of the output row.
The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

addUnamedInOutputArgument

PUBLIC:
Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The argumentFieldName is the field name of the argument to be used to pass to the procedure
and to be used is the result of the output row.

addUnamedInOutputArgument

PUBLIC:
Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The inArgumentFieldName is the field or argument name to be used to pass to the procedure.
The outArgumentFieldName is the field or argument name to be used is the result of the output row.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the JDBC type code, this dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY types.
The collectionClass is the java class to return instead of the ARRAY type.

PUBLIC:
Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The argumentFieldName is the field or argument name to be used is the result of the output row.
The jdbcType is the JDBC type code, this dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY and STRUCT types.
The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible.
The nestedType is a DatabaseField with type information set to match the VARRAYs object types

addUnamedInOutputArgumentValue

PUBLIC:
Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order.
The inArgumentValue is the value of the argument to be used to pass to the procedure.
The outArgumentFieldName is the field or argument name to be used is the result of the output row.
If these names are the same (as they normally are) this method can be called with a single argument.
The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

addUnamedOutputArgument

PUBLIC:
Define the field/argument name to be substitute for the index output argument.
This method is used if the procedure is not named and the order is explicit, names must be added in the correct order.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

addUnamedOutputArgument

PUBLIC:
Define the field/argument name to be substitute for the index output argument.
This method is used if the procedure is not named and the order is explicit, names must be added in the correct order.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

addUnamedOutputArgument

PUBLIC:
Define the field/argument name to be substitute for the index output argument.
This method is used if the procedure is not named and the order is explicit, names must be added in the correct order.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
The type is the JDBC type code, this is dependent on the type returned from the procedure.

addUnamedOutputArgument

PUBLIC:
Define the field/argument name to be substitute for the index output argument.
This method is used if the procedure is not named and the order is explicit, names must be added in the correct order.
The argumentFieldName is the field or argument name to be used to pass to the procedure.
The type is the JDBC type code, this is dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.

addUnamedOutputArgument

PUBLIC:
Define the field/argument name to be substitute for the index output argument.
This method is used if the procedure is not named and the order is explicit, names must be added in the correct order.
The argumentFieldName is the field or argument name to be used is the result of the output row.
The jdbcType is the JDBC type code, this dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY and STRUCT types.
The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible.

PUBLIC:
Define the field/argument name to be substitute for the index output argument.
This method is used if the procedure is not named and the order is explicit, names must be added in the correct order.
The argumentFieldName is the field or argument name to be used is the result of the output row.
The jdbcType is the JDBC type code, this dependent on the type returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY and STRUCT types.
The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible.
The nestedType is a DatabaseField with type information set to match the VARRAYs object types

addNamedCursorOutputArgument

ADVANCED:
Add the cursor output parameter to the procedure.
This is used for procedures that have multiple cursor output parameters.
If the procedure has a single cursor output parameter, then useNamedCursorOutputAsResultSet() should be used.

addUnnamedCursorOutputArgument

ADVANCED:
Add the cursor output parameter to the procedure.
This is used for procedures that have multiple cursor output parameters.
If the procedure has a single cursor output parameter, then useNamedCursorOutputAsResultSet() should be used.

useUnnamedCursorOutputAsResultSet

PUBLIC:
Used for Oracle result sets through procedures.
This can only be used if the arguments are not named but ordered.

setHasMultipleResultSets

public void setHasMultipleResultSets(boolean hasMultipleResultSets)

PUBLIC:
Set if the call returns multiple result sets.
Some databases support having stored procedures that return multiple result set.
This can be used by data queries, if an object query is used, all of the result sets must return
the required data to build the resulting class.

setReturnsResultSet

public void setReturnsResultSet(boolean returnsResultSet)

PUBLIC:
Some database support stored procedures returning result sets.
This default to true in the call has no output parameters, otherwise false.
If the call returns a result set, and has output parameters, this can be set to true.
If the call is used in a modify query, it is assumed to not have a result set,
result sets can only be used by read queries.
For Oracle a cursored output parameter can be used instead of a result set.