|
EclipseLink 1.1.4, build 'v20100812-r7860' API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.internal.databaseaccess.DatasourceCall
org.eclipse.persistence.internal.databaseaccess.DatabaseCall
org.eclipse.persistence.queries.StoredProcedureCall
public class StoredProcedureCall
Purpose: Used to define a platform independent procedure call. This supports output parameters. Procedures can also be called through custom SQL.
Field Summary | |
---|---|
protected java.util.Vector |
procedureArgumentNames
|
protected java.lang.String |
procedureName
|
Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall |
---|
fields, firstResult, FIRSTRESULT_FIELD, hasOptimisticLock, ignoreFirstRowMaxResultsSettings, isCallableStatementRequired, isCursorOutputProcedure, isFieldMatchingRequired, isResultSetScrollable, MAXROW_FIELD, maxRows, queryTimeout, result, resultSetConcurrency, resultSetFetchSize, resultSetType, returnsResultSet, shouldBuildOutputRow, shouldCacheStatement, sqlString, statement, usesBinding |
Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall |
---|
CUSTOM_MODIFY, IN, INOUT, isNativeConnectionRequired, isPrepared, LITERAL, MODIFY, NO_RETURN, OUT, OUT_CURSOR, parameters, parameterTypes, query, RETURN_CURSOR, RETURN_MANY_ROWS, RETURN_ONE_ROW, returnType, shouldProcessTokenInQuotes, TRANSLATION |
Constructor Summary | |
---|---|
StoredProcedureCall()
|
Method Summary | |
---|---|
void |
addNamedArgument(java.lang.String procedureParameterAndArgumentFieldName)
PUBLIC: Define the argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgument(java.lang.String procedureParameterName,
java.lang.String argumentFieldName)
PUBLIC: Define the argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgument(java.lang.String procedureParameterName,
java.lang.String argumentFieldName,
java.lang.Class type)
PUBLIC: Define the input argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgument(java.lang.String procedureParameterName,
java.lang.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(java.lang.String procedureParameterName,
java.lang.String argumentFieldName,
int type,
java.lang.String typeName)
PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedArgument(java.lang.String procedureParameterName,
java.lang.String argumentFieldName,
int type,
java.lang.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 |
addNamedArgumentValue(java.lang.String procedureParameterName,
java.lang.Object argumentValue)
PUBLIC: Define the argument to the stored procedure and the value to be substitute for it. |
void |
addNamedInOutputArgument(java.lang.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(java.lang.String procedureParameterName,
java.lang.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(java.lang.String procedureParameterName,
java.lang.String argumentFieldName,
java.lang.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(java.lang.String procedureParameterName,
java.lang.String inArgumentFieldName,
java.lang.String outArgumentFieldName,
java.lang.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(java.lang.String procedureParameterName,
java.lang.String inArgumentFieldName,
java.lang.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(java.lang.String procedureParameterName,
java.lang.String inArgumentFieldName,
java.lang.String outArgumentFieldName,
int type,
java.lang.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(java.lang.String procedureParameterName,
java.lang.String inArgumentFieldName,
java.lang.String outArgumentFieldName,
int type,
java.lang.String typeName,
java.lang.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(java.lang.String procedureParameterName,
java.lang.String inArgumentFieldName,
java.lang.String outArgumentFieldName,
int type,
java.lang.String typeName,
java.lang.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(java.lang.String procedureParameterName,
java.lang.Object inArgumentValue,
java.lang.String outArgumentFieldName,
java.lang.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(java.lang.String procedureParameterAndArgumentFieldName)
PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedOutputArgument(java.lang.String procedureParameterName,
java.lang.String argumentFieldName)
PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedOutputArgument(java.lang.String procedureParameterName,
java.lang.String argumentFieldName,
java.lang.Class type)
PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedOutputArgument(java.lang.String procedureParameterName,
java.lang.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(java.lang.String procedureParameterName,
java.lang.String argumentFieldName,
int type,
java.lang.String typeName)
PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedOutputArgument(java.lang.String procedureParameterName,
java.lang.String argumentFieldName,
int jdbcType,
java.lang.String typeName,
java.lang.Class javaType)
PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. |
void |
addNamedOutputArgument(java.lang.String procedureParameterName,
java.lang.String argumentFieldName,
int jdbcType,
java.lang.String typeName,
java.lang.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(java.lang.String argumentFieldName)
PUBLIC: Define the field/argument name to be substitute for the index argument. |
void |
addUnamedArgument(java.lang.String argumentFieldName,
java.lang.Class type)
PUBLIC: Define the argument to the stored procedure for the index argument. |
void |
addUnamedArgument(java.lang.String argumentFieldName,
int type)
PUBLIC: Define the argument to the stored procedure for the index argument. |
void |
addUnamedArgument(java.lang.String argumentFieldName,
int type,
java.lang.String typeName)
PUBLIC: Define the argument to the stored procedure for the index argument. |
void |
addUnamedArgument(java.lang.String argumentFieldName,
int type,
java.lang.String typeName,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
PUBLIC: Define the argument to the stored procedure for the index argument. |
void |
addUnamedArgumentValue(java.lang.Object argumentValue)
PUBLIC: Define the argument to the stored procedure for the index argument. |
void |
addUnamedInOutputArgument(java.lang.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(java.lang.String argumentFieldName,
java.lang.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(java.lang.String inArgumentFieldName,
java.lang.String outArgumentFieldName,
java.lang.Class type)
PUBLIC: Define the argument to the stored procedure for the index argument. |
void |
addUnamedInOutputArgument(java.lang.String inArgumentFieldName,
java.lang.String outArgumentFieldName,
int type)
PUBLIC: Define the argument to the stored procedure for the index argument. |
void |
addUnamedInOutputArgument(java.lang.String inArgumentFieldName,
java.lang.String outArgumentFieldName,
int type,
java.lang.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(java.lang.String inArgumentFieldName,
java.lang.String outArgumentFieldName,
int type,
java.lang.String typeName,
java.lang.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(java.lang.String inArgumentFieldName,
java.lang.String outArgumentFieldName,
int type,
java.lang.String typeName,
java.lang.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(java.lang.Object inArgumentValue,
java.lang.String outArgumentFieldName,
java.lang.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(java.lang.String argumentFieldName)
PUBLIC: Define the field/argument name to be substitute for the index output argument. |
void |
addUnamedOutputArgument(java.lang.String argumentFieldName,
java.lang.Class type)
PUBLIC: Define the field/argument name to be substitute for the index output argument. |
void |
addUnamedOutputArgument(java.lang.String argumentFieldName,
int type)
PUBLIC: Define the field/argument name to be substitute for the index output argument. |
void |
addUnamedOutputArgument(java.lang.String argumentFieldName,
int type,
java.lang.String typeName)
PUBLIC: Define the field/argument name to be substitute for the index output argument. |
void |
addUnamedOutputArgument(java.lang.String argumentFieldName,
int jdbcType,
java.lang.String typeName,
java.lang.Class javaType)
PUBLIC: Define the field/argument name to be substitute for the index output argument. |
void |
addUnamedOutputArgument(java.lang.String argumentFieldName,
int jdbcType,
java.lang.String typeName,
java.lang.Class javaType,
org.eclipse.persistence.internal.helper.DatabaseField nestedType)
PUBLIC: Define the field/argument name to be substitute for the index output argument. |
java.lang.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 |
java.util.Vector |
getProcedureArgumentNames()
INTERNAL: The if the names are provide the order is not required to match the call def. |
java.lang.String |
getProcedureName()
PUBLIC: Return the name of the store procedure on the database. |
boolean |
isStoredProcedureCall()
|
protected void |
prepareInternal(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Called by prepare method only. |
void |
setProcedureArgumentNames(java.util.Vector procedureArgumentNames)
INTERNAL: The if the names are provide the order is not required to match the call def. |
void |
setProcedureName(java.lang.String procedureName)
PUBLIC: (REQUIRED) Set the name of the store procedure on the database. |
java.lang.String |
toString()
|
void |
useNamedCursorOutputAsResultSet(java.lang.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, createInOutParameter, getCallString, getContexts, getCursorOutIndex, getFields, getFieldWithTypeFromDescriptor, getFirstResult, getLogString, getMaxRows, getOutputRowFields, getQueryString, getQueryTimeout, getResult, getResultSetConcurrency, getResultSetFetchSize, getResultSetType, getReturnsResultSet, getSQLString, getStatement, hasOptimisticLock, isCallableStatementRequired, isCursorOutputProcedure, isCursorReturned, isDynamicCall, isFieldMatchingRequired, isFinished, isLOBLocatorNeeded, isNonCursorOutputProcedure, isResultSetScrollable, matchFieldOrder, prepare, prepareInternalParameters, prepareStatement, setContexts, setFields, setFirstResult, setHasOptimisticLock, setIgnoreFirstRowMaxResultsSettings, setIsCallableStatementRequired, setIsCursorOutputProcedure, setIsFieldMatchingRequired, setIsResultSetScrollable, setMaxRows, setQueryString, setQueryTimeout, setResult, setResultSetConcurrency, setResultSetFetchSize, setResultSetType, setReturnsResultSet, setShouldBuildOutputRow, setShouldCacheStatement, setSQLStringInternal, setStatement, setUsesBinding, shouldBuildOutputRow, shouldCacheStatement, shouldCacheStatement, shouldIgnoreFirstRowMaxResultsSettings, translate, translateQueryStringForParameterizedIN, usesBinding, usesBinding |
Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall |
---|
appendIn, appendInOut, appendLiteral, appendModify, appendOut, appendTranslation, areManyRowsReturned, argumentMarker, clone, createField, getParameters, getParameterTypes, getQuery, getReturnType, getValueForInOutParameter, getValueForInParameter, hasParameters, isEISInteraction, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isSQLCall, isStoredFunctionCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setIsNativeConnectionRequired, setIsPrepared, setParameters, setParameterTypes, setQuery, setReturnType, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString, whitespace |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.String procedureName
protected java.util.Vector procedureArgumentNames
Constructor Detail |
---|
public StoredProcedureCall()
Method Detail |
---|
public void addNamedArgument(java.lang.String procedureParameterAndArgumentFieldName)
public void addNamedArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName)
public void addNamedArgumentValue(java.lang.String procedureParameterName, java.lang.Object argumentValue)
public void addNamedArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName, java.lang.Class type)
public void addNamedArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName, int type)
public void addNamedArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName, int type, java.lang.String typeName)
public void addNamedArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName, int type, java.lang.String typeName, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
public void addNamedInOutputArgument(java.lang.String procedureParameterAndArgumentFieldName)
public void addNamedInOutputArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName)
public void addNamedInOutputArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName, java.lang.Class type)
public void addNamedInOutputArgument(java.lang.String procedureParameterName, java.lang.String inArgumentFieldName, java.lang.String outArgumentFieldName, java.lang.Class type)
public void addNamedInOutputArgument(java.lang.String procedureParameterName, java.lang.String inArgumentFieldName, java.lang.String outArgumentFieldName, int type)
public void addNamedInOutputArgument(java.lang.String procedureParameterName, java.lang.String inArgumentFieldName, java.lang.String outArgumentFieldName, int type, java.lang.String typeName)
public void addNamedInOutputArgument(java.lang.String procedureParameterName, java.lang.String inArgumentFieldName, java.lang.String outArgumentFieldName, int type, java.lang.String typeName, java.lang.Class classType)
public void addNamedInOutputArgument(java.lang.String procedureParameterName, java.lang.String inArgumentFieldName, java.lang.String outArgumentFieldName, int type, java.lang.String typeName, java.lang.Class javaType, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
public void addNamedInOutputArgumentValue(java.lang.String procedureParameterName, java.lang.Object inArgumentValue, java.lang.String outArgumentFieldName, java.lang.Class type)
public void addNamedOutputArgument(java.lang.String procedureParameterAndArgumentFieldName)
public void addNamedOutputArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName)
public void addNamedOutputArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName, java.lang.Class type)
public void addNamedOutputArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName, int type)
public void addNamedOutputArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName, int type, java.lang.String typeName)
public void addNamedOutputArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName, int jdbcType, java.lang.String typeName, java.lang.Class javaType)
public void addNamedOutputArgument(java.lang.String procedureParameterName, java.lang.String argumentFieldName, int jdbcType, java.lang.String typeName, java.lang.Class javaType, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
public void addUnamedArgument(java.lang.String argumentFieldName)
public void addUnamedArgumentValue(java.lang.Object argumentValue)
public void addUnamedArgument(java.lang.String argumentFieldName, java.lang.Class type)
public void addUnamedArgument(java.lang.String argumentFieldName, int type)
public void addUnamedArgument(java.lang.String argumentFieldName, int type, java.lang.String typeName)
public void addUnamedArgument(java.lang.String argumentFieldName, int type, java.lang.String typeName, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
public void addUnamedInOutputArgument(java.lang.String inArgumentFieldName, java.lang.String outArgumentFieldName, java.lang.Class type)
public void addUnamedInOutputArgument(java.lang.String inArgumentFieldName, java.lang.String outArgumentFieldName, int type)
public void addUnamedInOutputArgument(java.lang.String inArgumentFieldName, java.lang.String outArgumentFieldName, int type, java.lang.String typeName)
public void addUnamedInOutputArgument(java.lang.String argumentFieldName, java.lang.Class type)
public void addUnamedInOutputArgument(java.lang.String argumentFieldName)
public void addUnamedInOutputArgument(java.lang.String inArgumentFieldName, java.lang.String outArgumentFieldName, int type, java.lang.String typeName, java.lang.Class collection)
public void addUnamedInOutputArgument(java.lang.String inArgumentFieldName, java.lang.String outArgumentFieldName, int type, java.lang.String typeName, java.lang.Class collection, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
public void addUnamedInOutputArgumentValue(java.lang.Object inArgumentValue, java.lang.String outArgumentFieldName, java.lang.Class type)
public void addUnamedOutputArgument(java.lang.String argumentFieldName)
public void addUnamedOutputArgument(java.lang.String argumentFieldName, java.lang.Class type)
public void addUnamedOutputArgument(java.lang.String argumentFieldName, int type)
public void addUnamedOutputArgument(java.lang.String argumentFieldName, int type, java.lang.String typeName)
public void addUnamedOutputArgument(java.lang.String argumentFieldName, int jdbcType, java.lang.String typeName, java.lang.Class javaType)
public void addUnamedOutputArgument(java.lang.String argumentFieldName, int jdbcType, java.lang.String typeName, java.lang.Class javaType, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
public java.lang.String getCallHeader(org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform)
public int getFirstParameterIndexForCallString()
public java.util.Vector getProcedureArgumentNames()
public java.lang.String getProcedureName()
public boolean isStoredProcedureCall()
isStoredProcedureCall
in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
protected void prepareInternal(org.eclipse.persistence.internal.sessions.AbstractSession session)
prepareInternal
in class org.eclipse.persistence.internal.databaseaccess.DatabaseCall
public void setProcedureArgumentNames(java.util.Vector procedureArgumentNames)
public void setProcedureName(java.lang.String procedureName)
public java.lang.String toString()
toString
in class org.eclipse.persistence.internal.databaseaccess.DatabaseCall
public void useNamedCursorOutputAsResultSet(java.lang.String argumentName)
public void useUnnamedCursorOutputAsResultSet()
useUnnamedCursorOutputAsResultSet
in class org.eclipse.persistence.internal.databaseaccess.DatabaseCall
|
EclipseLink 1.1.4, build 'v20100812-r7860' API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |