PLSQLStoredFunctionCall

java.lang.Object
- org.eclipse.persistence.internal.databaseaccess.DatasourceCall
- - org.eclipse.persistence.internal.databaseaccess.DatabaseCall
  - - org.eclipse.persistence.queries.StoredProcedureCall
    - - org.eclipse.persistence.platform.database.oracle.plsql.PLSQLStoredProcedureCall
      - org.eclipse.persistence.platform.database.oracle.plsql.PLSQLStoredFunctionCall

All Implemented Interfaces:

Serializable, Cloneable, Call
```
public class PLSQLStoredFunctionCall
extends PLSQLStoredProcedureCall
```
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.internal.databaseaccess.DatabaseCall
  FIRSTRESULT_FIELD, MAXROW_FIELD
- Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
  CUSTOM_MODIFY, IN, INLINE, INOUT, LITERAL, MODIFY, OUT, OUT_CURSOR, TRANSLATION

Constructor Summary

Constructors
Constructor and Description
`PLSQLStoredFunctionCall()`
`PLSQLStoredFunctionCall(org.eclipse.persistence.internal.helper.DatabaseType databaseType)`
`PLSQLStoredFunctionCall(org.eclipse.persistence.internal.helper.DatabaseType databaseType, int length)`
`PLSQLStoredFunctionCall(org.eclipse.persistence.internal.helper.DatabaseType databaseType, int length, int scale)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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:
`boolean`	`isStoredPLSQLFunctionCall()`
`void`	`prepareInternal(org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL:
`void`	`setResult(org.eclipse.persistence.internal.helper.DatabaseType databaseType)` PUBLIC: Define the return type of the function.
`void`	`setResult(org.eclipse.persistence.internal.helper.DatabaseType databaseType, int length)` PUBLIC: Define the return type of the function.
`void`	`setResult(org.eclipse.persistence.internal.helper.DatabaseType databaseType, int length, int scale)` PUBLIC: Define the return type of the function.

Methods inherited from class org.eclipse.persistence.platform.database.oracle.plsql.PLSQLStoredProcedureCall
addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgumentValue, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgumentValue, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addUnamedArgument, addUnamedArgument, addUnamedArgument, addUnamedArgument, addUnamedArgument, addUnamedArgumentValue, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgumentValue, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, buildOutputRow, getArguments, getLogString, getPl2SQLName, getSQL2PlName, isStoredPLSQLProcedureCall, setArguments, translate, useNamedCursorOutputAsResultSet, useNamedCursorOutputAsResultSet, useUnnamedCursorOutputAsResultSet

Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall
addContext, appendIn, appendInOut, appendInOut, appendLogParameters, appendOut, appendOutCursor, appendParameter, bindParameter, buildNewQueryMechanism, buildQueryMechanism, getCallString, getContexts, getCursorOutIndex, getExecuteReturnValue, getFields, getFieldsArray, getFirstResult, getMaxRows, getOutputCursors, getOutputRowFields, getQueryString, getQueryTimeout, getResult, getResultSetConcurrency, getResultSetFetchSize, getResultSetType, getReturnsResultSet, getSQLString, getStatement, hasAllocatedConnection, hasMultipleResultSets, hasOptimisticLock, hasOutputCursors, isBatchExecutionSupported, isCursorOutputProcedure, isCursorReturned, isFieldMatchingRequired, isFinished, isLOBLocatorNeeded, isMultipleCursorOutputProcedure, isNonCursorOutputProcedure, isResultSetScrollable, isUsesBindingSet, matchFieldOrder, prepare, prepareStatement, returnMultipleResultSetCollections, setBatchExecutionSupported, setContexts, setExecuteReturnValue, setFields, setFirstResult, setHasAllocatedConnection, setHasOptimisticLock, setIgnoreFirstRowSetting, setIgnoreMaxResultsSetting, setIsCursorOutputProcedure, setIsFieldMatchingRequired, setIsMultipleCursorOutputProcedure, setIsResultSetScrollable, setMaxRows, setQueryString, setQueryTimeout, setResult, setResultSetConcurrency, setResultSetFetchSize, setResultSetType, setReturnMultipleResultSetCollections, setShouldCacheStatement, setStatement, setUsesBinding, shouldBuildOutputRow, shouldCacheStatement, shouldCacheStatement, shouldIgnoreFirstRowSetting, shouldIgnoreMaxResultsSetting, 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, isExecuteUpdate, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isReturnSet, isSQLCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setExecuteUpdate, setIsNativeConnectionRequired, setIsPrepared, setParameters, setParameterTypes, setQuery, setReturnType, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PLSQLStoredFunctionCall
```
public PLSQLStoredFunctionCall()
```

PLSQLStoredFunctionCall

public PLSQLStoredFunctionCall(org.eclipse.persistence.internal.helper.DatabaseType databaseType)

PLSQLStoredFunctionCall

public PLSQLStoredFunctionCall(org.eclipse.persistence.internal.helper.DatabaseType databaseType,
                               int length)

PLSQLStoredFunctionCall

public PLSQLStoredFunctionCall(org.eclipse.persistence.internal.helper.DatabaseType databaseType,
                               int length,
                               int scale)

Method Detail
- getCallHeader
```
public 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
- isStoredPLSQLFunctionCall
```
public boolean isStoredPLSQLFunctionCall()
```
  Overrides:
  
  isStoredPLSQLFunctionCall in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
- prepareInternal
```
public void prepareInternal(org.eclipse.persistence.internal.sessions.AbstractSession session)
```
  INTERNAL:
- setResult
```
public void setResult(org.eclipse.persistence.internal.helper.DatabaseType databaseType)
```
  PUBLIC: Define the return type of the function.
- setResult
```
public void setResult(org.eclipse.persistence.internal.helper.DatabaseType databaseType,
                      int length)
```
  PUBLIC: Define the return type of the function.
- setResult
```
public void setResult(org.eclipse.persistence.internal.helper.DatabaseType databaseType,
                      int length,
                      int scale)
```
  PUBLIC: Define the return type of the function.

Class PLSQLStoredFunctionCall

Field Summary

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.platform.database.oracle.plsql.PLSQLStoredProcedureCall

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

PLSQLStoredFunctionCall

PLSQLStoredFunctionCall

PLSQLStoredFunctionCall

PLSQLStoredFunctionCall

Method Detail

getCallHeader

getFirstParameterIndexForCallString

isStoredFunctionCall

isStoredPLSQLFunctionCall

prepareInternal

setResult

setResult

setResult