Top Description Fields Constructors Methods
org.eclipse.persistence.platform.database.oracle.plsql

public Class PLSQLStoredFunctionCall

extends PLSQLStoredProcedureCall
Class Inheritance
Static Imports
org.eclipse.persistence.internal.helper.DatabaseType.DatabaseTypeHelper.databaseTypeHelper, .Helper.NL
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.

Field Summary

Inherited from org.eclipse.persistence.platform.database.oracle.plsql.PLSQLStoredProcedureCall:
argumentsBEGIN_BEGIN_BLOCKBEGIN_DECLARE_BLOCKBEGIN_DECLARE_FUNCTIONEND_BEGIN_BLOCKfunctionIdoriginalIndexPL2SQL_PREFIXRTURNSQL2PL_PREFIXtranslationRow

Constructor Summary

AccessConstructor and Description
public
PLSQLStoredFunctionCall()

public
PLSQLStoredFunctionCall(DatabaseType databaseType)

public
PLSQLStoredFunctionCall(DatabaseType databaseType, int length)

public
PLSQLStoredFunctionCall(DatabaseType databaseType, int length, int scale)

Method Summary

Modifier and TypeMethod and Description
protected void
buildProcedureInvocation(StringBuilder sb, List<PLSQLargument> arguments)

Overrides org.eclipse.persistence.platform.database.oracle.plsql.PLSQLStoredProcedureCall.buildProcedureInvocation.

INTERNAL Generate portion of the Anonymous PL/SQL block that invokes the target function.
public String
getCallHeader(DatabasePlatform platform)

Overrides org.eclipse.persistence.queries.StoredProcedureCall.getCallHeader.

INTERNAL: Return call header for the call string.
public int
getFirstParameterIndexForCallString()

Overrides org.eclipse.persistence.queries.StoredProcedureCall.getFirstParameterIndexForCallString.

INTERNAL: Return the first index of parameter to be placed inside brackets in the call string.
public boolean
isStoredFunctionCall()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.isStoredFunctionCall.

INTERNAL:
public boolean
isStoredPLSQLFunctionCall()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.isStoredPLSQLFunctionCall.

public void
prepareInternal(AbstractSession session)

Overrides org.eclipse.persistence.platform.database.oracle.plsql.PLSQLStoredProcedureCall.prepareInternal.

INTERNAL:
public void
setResult(DatabaseType databaseType)

PUBLIC: Define the return type of the function.

public void
setResult(DatabaseType databaseType, int length)

PUBLIC: Define the return type of the function.

public void
setResult(DatabaseType databaseType, int length, int scale)

PUBLIC: Define the return type of the function.

Inherited from org.eclipse.persistence.platform.database.oracle.plsql.PLSQLStoredProcedureCall:
addNamedArgumentaddNamedArgumentaddNamedArgumentaddNamedArgumentaddNamedArgumentaddNamedArgumentaddNamedArgumentaddNamedArgumentValueaddNamedInOutputArgumentaddNamedInOutputArgumentaddNamedInOutputArgumentaddNamedInOutputArgumentaddNamedInOutputArgumentaddNamedInOutputArgumentaddNamedInOutputArgumentaddNamedInOutputArgumentaddNamedInOutputArgumentaddNamedInOutputArgumentaddNamedInOutputArgumentaddNamedInOutputArgumentValueaddNamedOutputArgumentaddNamedOutputArgumentaddNamedOutputArgumentaddNamedOutputArgumentaddNamedOutputArgumentaddNamedOutputArgumentaddNamedOutputArgumentaddNamedOutputArgumentaddNamedOutputArgumentaddNamedOutputArgumentaddNestedFunctionsForArgumentaddUnamedArgumentaddUnamedArgumentaddUnamedArgumentaddUnamedArgumentaddUnamedArgumentaddUnamedArgumentValueaddUnamedInOutputArgumentaddUnamedInOutputArgumentaddUnamedInOutputArgumentaddUnamedInOutputArgumentaddUnamedInOutputArgumentaddUnamedInOutputArgumentaddUnamedInOutputArgumentaddUnamedInOutputArgumentValueaddUnamedOutputArgumentaddUnamedOutputArgumentaddUnamedOutputArgumentaddUnamedOutputArgumentaddUnamedOutputArgumentaddUnamedOutputArgumentassignIndicesbuildBeginBlockbuildDeclareBlockbuildNestedFunctionsbuildOutAssignmentsbuildOutputRowgetArgumentsgetArgumentsgetLogStringgetOutputParameterValuegetPl2SQLNamegetSQL2PlNameisStoredPLSQLProcedureCallprepareStatementsetArgumentstranslateuseNamedCursorOutputAsResultSetuseNamedCursorOutputAsResultSetuseUnnamedCursorOutputAsResultSet

Constructor Detail

PLSQLStoredFunctionCallback to summary
public PLSQLStoredFunctionCall()
PLSQLStoredFunctionCallback to summary
public PLSQLStoredFunctionCall(DatabaseType databaseType)
PLSQLStoredFunctionCallback to summary
public PLSQLStoredFunctionCall(DatabaseType databaseType, int length)
PLSQLStoredFunctionCallback to summary
public PLSQLStoredFunctionCall(DatabaseType databaseType, int length, int scale)

Method Detail

buildProcedureInvocationback to summary
protected void buildProcedureInvocation(StringBuilder sb, List<PLSQLargument> arguments)

Overrides org.eclipse.persistence.platform.database.oracle.plsql.PLSQLStoredProcedureCall.buildProcedureInvocation.

INTERNAL Generate portion of the Anonymous PL/SQL block that invokes the target function.

Annotations
@Override
getCallHeaderback to summary
public String getCallHeader(DatabasePlatform platform)

Overrides org.eclipse.persistence.queries.StoredProcedureCall.getCallHeader.

INTERNAL: Return call header for the call string.

Annotations
@Override
getFirstParameterIndexForCallStringback to summary
public int getFirstParameterIndexForCallString()

Overrides org.eclipse.persistence.queries.StoredProcedureCall.getFirstParameterIndexForCallString.

INTERNAL: Return the first index of parameter to be placed inside brackets in the call string.

Annotations
@Override
isStoredFunctionCallback to summary
public boolean isStoredFunctionCall()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.isStoredFunctionCall.

INTERNAL:

Annotations
@Override
isStoredPLSQLFunctionCallback to summary
public boolean isStoredPLSQLFunctionCall()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.isStoredPLSQLFunctionCall.

Annotations
@Override
prepareInternalback to summary
public void prepareInternal(AbstractSession session)

Overrides org.eclipse.persistence.platform.database.oracle.plsql.PLSQLStoredProcedureCall.prepareInternal.

INTERNAL:

Annotations
@Override
setResultback to summary
public void setResult(DatabaseType databaseType)

PUBLIC: Define the return type of the function.

setResultback to summary
public void setResult(DatabaseType databaseType, int length)

PUBLIC: Define the return type of the function.

setResultback to summary
public void setResult(DatabaseType databaseType, int length, int scale)

PUBLIC: Define the return type of the function.