StoredFunctionCall (EclipseLink 2.6.1, API Reference)

java.lang.Object
- org.eclipse.persistence.internal.databaseaccess.DatasourceCall
- - org.eclipse.persistence.internal.databaseaccess.DatabaseCall
  - - org.eclipse.persistence.queries.StoredProcedureCall
    - - org.eclipse.persistence.queries.StoredFunctionCall

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Call
```
public class StoredFunctionCall
extends StoredProcedureCall
```
Purpose: Used to define a platform independent function call. Note that not all platforms support stored functions. This supports output parameters. Functions can also be called through custom SQL.

See Also:
Serialized Form

Field Summary
- Fields inherited from class org.eclipse.persistence.queries.StoredProcedureCall
  cursorOrdinalPositions, optionalArguments, procedureArgumentNames, procedureName
- Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall
  executeReturnValue, fields, fieldsArray, firstResult, FIRSTRESULT_FIELD, hasAllocatedConnection, hasMultipleResultSets, hasOptimisticLock, ignoreFirstRowSetting, ignoreMaxResultsSetting, isBatchExecutionSupported, isCallableStatementRequired, isCursorOutputProcedure, isFieldMatchingRequired, isMultipleCursorOutputProcedure, isResultSetScrollable, MAXROW_FIELD, maxRows, outputCursors, queryTimeout, result, resultSetConcurrency, resultSetFetchSize, resultSetType, returnMultipleResultSetCollections, returnsResultSet, shouldBuildOutputRow, shouldCacheStatement, sqlString, statement, usesBinding
- Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
  CUSTOM_MODIFY, EXECUTE_UPDATE, IN, INLINE, 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

Constructors
Constructor and Description
`StoredFunctionCall()`
`StoredFunctionCall(int sqlType, java.lang.String sqlTypeName, java.lang.Class javaType)`
`StoredFunctionCall(int sqlType, java.lang.String sqlTypeName, java.lang.Class javaType, org.eclipse.persistence.internal.helper.DatabaseField nestedType)`
`StoredFunctionCall(int sqlType, java.lang.String sqlTypeName, java.lang.String javaTypeClassName)`
`StoredFunctionCall(int sqlType, java.lang.String sqlTypeName, java.lang.String javaTypeClassName, org.eclipse.persistence.internal.helper.DatabaseField nestedType)`

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`boolean`	`isStoredFunctionCall()` INTERNAL:
`void`	`prepareInternal(org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL:
`void`	`setResult(int type, java.lang.String typeName, java.lang.Class javaType)` PUBLIC: Define the ObjectRelationalDatabaseField to be substituted for the function return.
`void`	`setResult(int type, java.lang.String typeName, java.lang.Class javaType, org.eclipse.persistence.internal.helper.DatabaseField nestedType)` PUBLIC: Define the ObjectRelationalDatabaseField to be substituted for the function return.
`void`	`setResult(java.lang.String name)` PUBLIC: Define the field name to be substitute for the function return.
`void`	`setResult(java.lang.String name, java.lang.Class type)` PUBLIC: Define the field name to be substitute for the function return.
`void`	`setResult(java.lang.String name, int type)` PUBLIC: Define the field name to be substitute for the function return.
`void`	`setResult(java.lang.String name, int type, java.lang.String typeName)` PUBLIC: Define the field name to be substitute for the function return.
`void`	`setResultCursor()` PUBLIC: Define to return cursor as result.

Methods inherited from class org.eclipse.persistence.queries.StoredProcedureCall
addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgumentValue, addNamedCursorOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgumentValue, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addOptionalArgument, addUnamedArgument, addUnamedArgument, addUnamedArgument, addUnamedArgument, addUnamedArgument, addUnamedArgumentValue, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgumentValue, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, addUnnamedCursorOutputArgument, getCursorOrdinalPosition, getCursorOrdinalPositions, getOptionalArguments, getProcedureArgumentNames, getProcedureName, hasOptionalArguments, isStoredProcedureCall, setCursorOrdinalPosition, setHasMultipleResultSets, setOptionalArguments, setProcedureArgumentNames, setProcedureName, setReturnsResultSet, toString, useCursorOutputResultSet, useNamedCursorOutputAsResultSet, useUnnamedCursorOutputAsResultSet, useUnnamedCursorOutputAsResultSet

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, getExecuteReturnValue, getFields, getFieldsArray, getFieldWithTypeFromDescriptor, getFirstResult, getLogString, getMaxRows, getOutputCursors, getOutputRowFields, getQueryString, getQueryTimeout, getResult, getResultSetConcurrency, getResultSetFetchSize, getResultSetType, getReturnsResultSet, getSQLString, getStatement, hasAllocatedConnection, hasMultipleResultSets, hasOptimisticLock, hasOutputCursors, isBatchExecutionSupported, isCallableStatementRequired, isCursorOutputProcedure, isCursorReturned, isDynamicCall, isFieldMatchingRequired, isFinished, isLOBLocatorNeeded, isMultipleCursorOutputProcedure, isNonCursorOutputProcedure, isResultSetScrollable, isUsesBindingSet, matchFieldOrder, prepare, prepareInternalParameters, prepareStatement, returnMultipleResultSetCollections, setBatchExecutionSupported, setContexts, setExecuteReturnValue, setFields, setFirstResult, setHasAllocatedConnection, setHasOptimisticLock, setIgnoreFirstRowSetting, setIgnoreMaxResultsSetting, setIsCallableStatementRequired, setIsCursorOutputProcedure, setIsFieldMatchingRequired, setIsMultipleCursorOutputProcedure, setIsResultSetScrollable, setMaxRows, setQueryString, setQueryTimeout, setResult, setResultSetConcurrency, setResultSetFetchSize, setResultSetType, setReturnMultipleResultSetCollections, setShouldBuildOutputRow, setShouldCacheStatement, setSQLStringInternal, 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, argumentMarker, clone, createField, getParameters, getParameterTypes, getQuery, getReturnType, getValueForInOutParameter, getValueForInParameter, hasParameters, isEISInteraction, isExecuteUpdate, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isReturnSet, isSQLCall, isStoredPLSQLFunctionCall, isStoredPLSQLProcedureCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setExecuteUpdate, 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

- Constructor Detail
  - StoredFunctionCall
```
public StoredFunctionCall()
```
  - StoredFunctionCall
```
public StoredFunctionCall(int sqlType,
                  java.lang.String sqlTypeName,
                  java.lang.Class javaType)
```
  - StoredFunctionCall
```
public StoredFunctionCall(int sqlType,
                  java.lang.String sqlTypeName,
                  java.lang.Class javaType,
                  org.eclipse.persistence.internal.helper.DatabaseField nestedType)
```
  - StoredFunctionCall
```
public StoredFunctionCall(int sqlType,
                  java.lang.String sqlTypeName,
                  java.lang.String javaTypeClassName)
```
  - StoredFunctionCall
```
public StoredFunctionCall(int sqlType,
                  java.lang.String sqlTypeName,
                  java.lang.String javaTypeClassName,
                  org.eclipse.persistence.internal.helper.DatabaseField nestedType)
```
- Method Detail
  - getCallHeader
```
public java.lang.String getCallHeader(org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform)
```
    INTERNAL: Return call header for the call string.
    
    Overrides:
    
    getCallHeader in class StoredProcedureCall
  - getFirstParameterIndexForCallString
```
public int getFirstParameterIndexForCallString()
```
    INTERNAL: Return the first index of parameter to be placed inside brackets in the call string.
    
    Overrides:
    
    getFirstParameterIndexForCallString in class StoredProcedureCall
  - isStoredFunctionCall
```
public boolean isStoredFunctionCall()
```
    INTERNAL:
    
    Overrides:
    
    isStoredFunctionCall in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
  - prepareInternal
```
public void prepareInternal(org.eclipse.persistence.internal.sessions.AbstractSession session)
```
    INTERNAL:
    
    Overrides:
    
    prepareInternal in class StoredProcedureCall
  - setResult
```
public void setResult(java.lang.String name)
```
    PUBLIC: Define the field name to be substitute for the function return.
  - setResult
```
public void setResult(java.lang.String name,
             java.lang.Class type)
```
    PUBLIC: Define the field name to be substitute for the function return. The type is the type of Java class desired back from the function, this is dependent on the type returned from the function.
  - setResult
```
public void setResult(java.lang.String name,
             int type,
             java.lang.String typeName)
```
    PUBLIC: Define the field name to be substitute for the function return. The type is the type of Java class desired back from the function, this is dependent on the type returned from the function.
  - setResult
```
public void setResult(int type,
             java.lang.String typeName,
             java.lang.Class javaType)
```
    PUBLIC: Define the ObjectRelationalDatabaseField to be substituted for the function return. 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
  - setResult
```
public void setResult(int type,
             java.lang.String typeName,
             java.lang.Class javaType,
             org.eclipse.persistence.internal.helper.DatabaseField nestedType)
```
    PUBLIC: Define the ObjectRelationalDatabaseField to be substituted for the function return. This will typically be called for ARRAY types. 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 types. The javaType is the mapped Class that has an ObjectRelationalDataTypeDescriptor for the ARRAY type typeName The nestedType is a database field representing the type the ARRAY holds onto.
  - setResult
```
public void setResult(java.lang.String name,
             int type)
```
    PUBLIC: Define the field name to be substitute for the function return. The type is the type of Java class desired back from the function, this is dependent on the type returned from the function.
  - setResultCursor
```
public void setResultCursor()
```
    PUBLIC: Define to return cursor as result.

Class StoredFunctionCall

Field Summary

Fields inherited from class org.eclipse.persistence.queries.StoredProcedureCall

Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall

Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.queries.StoredProcedureCall

Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall

Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

Methods inherited from class java.lang.Object

Constructor Detail

StoredFunctionCall

StoredFunctionCall

StoredFunctionCall

StoredFunctionCall

StoredFunctionCall

Method Detail

getCallHeader

getFirstParameterIndexForCallString

isStoredFunctionCall

prepareInternal

setResult

setResult

setResult

setResult

setResult

setResult

setResultCursor