org.eclipse.persistence.queries
Class StoredProcedureCall
java.lang.Object
org.eclipse.persistence.internal.databaseaccess.DatasourceCall
org.eclipse.persistence.internal.databaseaccess.DatabaseCall
org.eclipse.persistence.queries.StoredProcedureCall
- All Implemented Interfaces:
- Serializable, Cloneable, Call
- Direct Known Subclasses:
- StoredFunctionCall
public class StoredProcedureCall
- extends org.eclipse.persistence.internal.databaseaccess.DatabaseCall
Purpose: Used to define a platform independent procedure call.
This supports output parameters.
Procedures can also be called through custom SQL.
- See Also:
- Serialized Form
Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall |
FIRSTRESULT_FIELD, MAXROW_FIELD |
Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall |
CUSTOM_MODIFY, IN, INOUT, LITERAL, MODIFY, OUT, OUT_CURSOR, TRANSLATION |
Method Summary |
void |
addNamedArgument(String procedureParameterAndArgumentFieldName)
PUBLIC:
Define the argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgument(String procedureParameterName,
String argumentFieldName)
PUBLIC:
Define the argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgument(String procedureParameterName,
String argumentFieldName,
Class type)
PUBLIC:
Define the input argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgument(String procedureParameterName,
String argumentFieldName,
int type)
PUBLIC:
Define the input argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgument(String procedureParameterName,
String argumentFieldName,
int type,
String typeName)
PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgument(String procedureParameterName,
String argumentFieldName,
int type,
String typeName,
Class javaType)
PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgument(String procedureParameterName,
String argumentFieldName,
int type,
String typeName,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgument(String procedureParameterName,
String argumentFieldName,
int type,
String typeName,
String javaTypeName)
PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgumentValue(String procedureParameterName,
Object argumentValue)
PUBLIC:
Define the argument to the stored procedure and the value to be substitute for it. |
void |
addNamedInOutputArgument(String procedureParameterAndArgumentFieldName)
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. |
void |
addNamedInOutputArgument(String procedureParameterName,
String argumentFieldName)
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. |
void |
addNamedInOutputArgument(String procedureParameterName,
String argumentFieldName,
Class type)
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. |
void |
addNamedInOutputArgument(String procedureParameterName,
String inArgumentFieldName,
String outArgumentFieldName,
Class type)
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. |
void |
addNamedInOutputArgument(String procedureParameterName,
String inArgumentFieldName,
String outArgumentFieldName,
int type)
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. |
void |
addNamedInOutputArgument(String procedureParameterName,
String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName)
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. |
void |
addNamedInOutputArgument(String procedureParameterName,
String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName,
Class classType)
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. |
void |
addNamedInOutputArgument(String procedureParameterName,
String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName,
Class javaType,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
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. |
void |
addNamedInOutputArgumentValue(String procedureParameterName,
Object inArgumentValue,
String outArgumentFieldName,
Class type)
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. |
void |
addNamedOutputArgument(String procedureParameterAndArgumentFieldName)
PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedOutputArgument(String procedureParameterName,
String argumentFieldName)
PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedOutputArgument(String procedureParameterName,
String argumentFieldName,
Class type)
PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedOutputArgument(String procedureParameterName,
String argumentFieldName,
int type)
PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedOutputArgument(String procedureParameterName,
String argumentFieldName,
int type,
String typeName)
PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedOutputArgument(String procedureParameterName,
String argumentFieldName,
int jdbcType,
String typeName,
Class javaType)
PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedOutputArgument(String procedureParameterName,
String argumentFieldName,
int jdbcType,
String typeName,
Class javaType,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
PUBLIC:
Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addUnamedArgument(String argumentFieldName)
PUBLIC:
Define the field/argument name to be substitute for the index argument. |
void |
addUnamedArgument(String argumentFieldName,
Class type)
PUBLIC:
Define the argument to the stored procedure for the index argument. |
void |
addUnamedArgument(String argumentFieldName,
int type)
PUBLIC:
Define the argument to the stored procedure for the index argument. |
void |
addUnamedArgument(String argumentFieldName,
int type,
String typeName)
PUBLIC:
Define the argument to the stored procedure for the index argument. |
void |
addUnamedArgument(String argumentFieldName,
int type,
String typeName,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
PUBLIC:
Define the argument to the stored procedure for the index argument. |
void |
addUnamedArgumentValue(Object argumentValue)
PUBLIC:
Define the argument to the stored procedure for the index argument. |
void |
addUnamedInOutputArgument(String argumentFieldName)
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. |
void |
addUnamedInOutputArgument(String argumentFieldName,
Class 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. |
void |
addUnamedInOutputArgument(String inArgumentFieldName,
String outArgumentFieldName,
Class type)
PUBLIC:
Define the argument to the stored procedure for the index argument. |
void |
addUnamedInOutputArgument(String inArgumentFieldName,
String outArgumentFieldName,
int type)
PUBLIC:
Define the argument to the stored procedure for the index argument. |
void |
addUnamedInOutputArgument(String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName)
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. |
void |
addUnamedInOutputArgument(String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName,
Class collection)
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. |
void |
addUnamedInOutputArgument(String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName,
Class collection,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
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. |
void |
addUnamedInOutputArgumentValue(Object inArgumentValue,
String outArgumentFieldName,
Class 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. |
void |
addUnamedOutputArgument(String argumentFieldName)
PUBLIC:
Define the field/argument name to be substitute for the index output argument. |
void |
addUnamedOutputArgument(String argumentFieldName,
Class type)
PUBLIC:
Define the field/argument name to be substitute for the index output argument. |
void |
addUnamedOutputArgument(String argumentFieldName,
int type)
PUBLIC:
Define the field/argument name to be substitute for the index output argument. |
void |
addUnamedOutputArgument(String argumentFieldName,
int type,
String typeName)
PUBLIC:
Define the field/argument name to be substitute for the index output argument. |
void |
addUnamedOutputArgument(String argumentFieldName,
int jdbcType,
String typeName,
Class javaType)
PUBLIC:
Define the field/argument name to be substitute for the index output argument. |
void |
addUnamedOutputArgument(String argumentFieldName,
int jdbcType,
String typeName,
Class javaType,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
PUBLIC:
Define the field/argument name to be substitute for the index output argument. |
String |
getCallHeader(org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform)
INTERNAL:
Return call header for the call string. |
int |
getFirstParameterIndexForCallString()
INTERNAL:
Return the first index of parameter to be placed inside brackets
in the call string |
Vector |
getProcedureArgumentNames()
INTERNAL:
The if the names are provide the order is not required to match the call def. |
String |
getProcedureName()
PUBLIC:
Return the name of the store procedure on the database. |
boolean |
isStoredProcedureCall()
|
void |
setProcedureArgumentNames(Vector procedureArgumentNames)
INTERNAL:
The if the names are provide the order is not required to match the call def. |
void |
setProcedureName(String procedureName)
PUBLIC: (REQUIRED)
Set the name of the store procedure on the database. |
String |
toString()
INTERNAL:
Print the SQL string. |
void |
useNamedCursorOutputAsResultSet(String argumentName)
PUBLIC:
Used for Oracle result sets through procedures. |
void |
useUnnamedCursorOutputAsResultSet()
PUBLIC:
Used for Oracle result sets through procedures. |
Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall |
addContext, appendIn, appendInOut, appendInOut, appendLogParameters, appendOut, appendOutCursor, appendParameter, bindParameter, buildNewQueryMechanism, buildOutputRow, buildQueryMechanism, getCallString, getContexts, getCursorOutIndex, getFields, getFirstResult, getLogString, getMaxRows, getOutputRowFields, getQueryString, getQueryTimeout, getResult, getResultSetConcurrency, getResultSetFetchSize, getResultSetType, getReturnsResultSet, getSQLString, getStatement, hasOptimisticLock, isCursorOutputProcedure, isCursorReturned, isFieldMatchingRequired, isFinished, isLOBLocatorNeeded, isNonCursorOutputProcedure, isResultSetScrollable, isUsesBindingSet, matchFieldOrder, prepare, prepareStatement, setContexts, setFields, setFirstResult, setHasOptimisticLock, setIgnoreFirstRowSetting, setIgnoreMaxResultsSetting, setIsCursorOutputProcedure, setIsFieldMatchingRequired, setIsResultSetScrollable, setMaxRows, setQueryString, setQueryTimeout, setResult, setResultSetConcurrency, setResultSetFetchSize, setResultSetType, setReturnsResultSet, setShouldCacheStatement, setStatement, setUsesBinding, shouldBuildOutputRow, shouldCacheStatement, shouldCacheStatement, shouldIgnoreFirstRowSetting, shouldIgnoreMaxResultsSetting, translate, translateQueryStringForParameterizedIN, usesBinding, usesBinding |
Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall |
appendIn, appendInOut, appendLiteral, appendModify, appendOut, appendTranslation, areManyRowsReturned, clone, getParameters, getParameterTypes, getQuery, getReturnType, hasParameters, isEISInteraction, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isQueryStringCall, isReturnSet, isSQLCall, isStoredFunctionCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setIsNativeConnectionRequired, setParameters, setParameterTypes, setQuery, setReturnType, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString |
StoredProcedureCall
public StoredProcedureCall()
addNamedArgument
public void addNamedArgument(String procedureParameterAndArgumentFieldName)
- 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 void addNamedArgument(String procedureParameterName,
String argumentFieldName)
- 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 void addNamedArgumentValue(String procedureParameterName,
Object argumentValue)
- 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 void addNamedArgument(String procedureParameterName,
String argumentFieldName,
Class type)
- 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 void addNamedArgument(String procedureParameterName,
String argumentFieldName,
int type)
- 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 void addNamedArgument(String procedureParameterName,
String argumentFieldName,
int type,
String 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, this may be required for ARRAY or STRUCT types.
addNamedArgument
public void addNamedArgument(String procedureParameterName,
String argumentFieldName,
int type,
String typeName,
Class javaType)
- 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
addNamedArgument
public void addNamedArgument(String procedureParameterName,
String argumentFieldName,
int type,
String typeName,
String javaTypeName)
- 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
addNamedArgument
public void addNamedArgument(String procedureParameterName,
String argumentFieldName,
int type,
String typeName,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
- 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 void addNamedInOutputArgument(String procedureParameterAndArgumentFieldName)
- 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 void addNamedInOutputArgument(String procedureParameterName,
String argumentFieldName)
- 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 void addNamedInOutputArgument(String procedureParameterName,
String argumentFieldName,
Class type)
- 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 void addNamedInOutputArgument(String procedureParameterName,
String inArgumentFieldName,
String outArgumentFieldName,
Class type)
- 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 void addNamedInOutputArgument(String procedureParameterName,
String inArgumentFieldName,
String outArgumentFieldName,
int type)
- 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 void addNamedInOutputArgument(String procedureParameterName,
String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName)
- 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.
addNamedInOutputArgument
public void addNamedInOutputArgument(String procedureParameterName,
String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName,
Class classType)
- 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.
addNamedInOutputArgument
public void addNamedInOutputArgument(String procedureParameterName,
String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName,
Class javaType,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
- 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 void addNamedInOutputArgumentValue(String procedureParameterName,
Object inArgumentValue,
String outArgumentFieldName,
Class type)
- 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 void addNamedOutputArgument(String procedureParameterAndArgumentFieldName)
- 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 void addNamedOutputArgument(String procedureParameterName,
String argumentFieldName)
- 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 void addNamedOutputArgument(String procedureParameterName,
String argumentFieldName,
Class type)
- 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 void addNamedOutputArgument(String procedureParameterName,
String argumentFieldName,
int type)
- 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 void addNamedOutputArgument(String procedureParameterName,
String argumentFieldName,
int type,
String 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 returned from the procedure.
The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.
addNamedOutputArgument
public void addNamedOutputArgument(String procedureParameterName,
String argumentFieldName,
int jdbcType,
String typeName,
Class javaType)
- 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.
addNamedOutputArgument
public void addNamedOutputArgument(String procedureParameterName,
String argumentFieldName,
int jdbcType,
String typeName,
Class javaType,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
- 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(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(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 void addUnamedArgument(String argumentFieldName,
Class type)
- 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 void addUnamedArgument(String argumentFieldName,
int type)
- 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 void addUnamedArgument(String argumentFieldName,
int type,
String typeName)
- 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 void addUnamedArgument(String argumentFieldName,
int type,
String typeName,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
- 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 void addUnamedInOutputArgument(String inArgumentFieldName,
String outArgumentFieldName,
Class type)
- 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 void addUnamedInOutputArgument(String inArgumentFieldName,
String outArgumentFieldName,
int type)
- 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 void addUnamedInOutputArgument(String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName)
- 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 void addUnamedInOutputArgument(String argumentFieldName,
Class 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 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 void addUnamedInOutputArgument(String argumentFieldName)
- 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 void addUnamedInOutputArgument(String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName,
Class collection)
- 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.
addUnamedInOutputArgument
public void addUnamedInOutputArgument(String inArgumentFieldName,
String outArgumentFieldName,
int type,
String typeName,
Class collection,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
- 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 void addUnamedInOutputArgumentValue(Object inArgumentValue,
String outArgumentFieldName,
Class 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 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 void addUnamedOutputArgument(String argumentFieldName)
- 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 void addUnamedOutputArgument(String argumentFieldName,
Class type)
- 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 void addUnamedOutputArgument(String argumentFieldName,
int type)
- 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 void addUnamedOutputArgument(String argumentFieldName,
int type,
String typeName)
- 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 void addUnamedOutputArgument(String argumentFieldName,
int jdbcType,
String typeName,
Class javaType)
- 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.
addUnamedOutputArgument
public void addUnamedOutputArgument(String argumentFieldName,
int jdbcType,
String typeName,
Class javaType,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
- 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
getCallHeader
public String getCallHeader(org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform)
- INTERNAL:
Return call header for the call string.
getFirstParameterIndexForCallString
public int getFirstParameterIndexForCallString()
- INTERNAL:
Return the first index of parameter to be placed inside brackets
in the call string
getProcedureArgumentNames
public Vector getProcedureArgumentNames()
- INTERNAL:
The if the names are provide the order is not required to match the call def.
This is lazy initialized to conserve space on calls that have no parameters.
getProcedureName
public String getProcedureName()
- PUBLIC:
Return the name of the store procedure on the database.
isStoredProcedureCall
public boolean isStoredProcedureCall()
- Overrides:
isStoredProcedureCall
in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
setProcedureArgumentNames
public void setProcedureArgumentNames(Vector procedureArgumentNames)
- INTERNAL:
The if the names are provide the order is not required to match the call def.
This is lazy initialized to conserve space on calls that have no parameters.
setProcedureName
public void setProcedureName(String procedureName)
- PUBLIC: (REQUIRED)
Set the name of the store procedure on the database.
toString
public String toString()
- Description copied from class:
org.eclipse.persistence.internal.databaseaccess.DatabaseCall
- INTERNAL:
Print the SQL string.
- Overrides:
toString
in class org.eclipse.persistence.internal.databaseaccess.DatabaseCall
useNamedCursorOutputAsResultSet
public void useNamedCursorOutputAsResultSet(String argumentName)
- PUBLIC:
Used for Oracle result sets through procedures.
This can only be used if the arguments are not named but ordered.
useUnnamedCursorOutputAsResultSet
public void useUnnamedCursorOutputAsResultSet()
- PUBLIC:
Used for Oracle result sets through procedures.
This can only be used if the arguments are not named but ordered.
- Overrides:
useUnnamedCursorOutputAsResultSet
in class org.eclipse.persistence.internal.databaseaccess.DatabaseCall