Top Description Methods
org.eclipse.persistence.platform.database.oracle.annotations

public @Interface NamedPLSQLStoredFunctionQuery

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
Imports
java.lang.annotation.Retention, .Target, jakarta.persistence.QueryHint
A NamedPLSQLStoredFunctionQuery annotation allows the definition of queries that call PLSQL stored functions as named queries. The PLSQL support adds support for complex PLSQL types such as RECORD and TABLE types, that are not accessible from JDBC. A NamedPLSQLStoredFunctionQuery annotation may be defined on an Entity or MappedSuperclass.
Author
James Sutherland
Since
EclipseLink 2.3

Method Summary

Modifier and TypeMethod and Description
public String
functionName()

(Required) The name of the stored procedure.

public QueryHint[]
hints()

(Optional) Query hints.

public String
name()

(Required) Unique name that references this stored procedure query.

public PLSQLParameter[]
parameters()

(Optional) Defines the parameters to the stored procedure.

public String
resultSetMapping()

(Optional) The name of the SQLResultMapping.

public PLSQLParameter
returnParameter()

(Required) Defines the return value of the stored function.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

functionNameback to summary
public String functionName()

(Required) The name of the stored procedure.

hintsback to summary
public QueryHint[] hints()

(Optional) Query hints.

nameback to summary
public String name()

(Required) Unique name that references this stored procedure query.

parametersback to summary
public PLSQLParameter[] parameters()

(Optional) Defines the parameters to the stored procedure.

resultSetMappingback to summary
public String resultSetMapping()

(Optional) The name of the SQLResultMapping.

returnParameterback to summary
public PLSQLParameter returnParameter()

(Required) Defines the return value of the stored function.