EclipseLink 2.3.2, build 'v20111125-r10461' API Reference

org.eclipse.persistence.platform.database.oracle.annotations
Annotation Type NamedPLSQLStoredFunctionQuery


@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface NamedPLSQLStoredFunctionQuery

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

Required Element Summary
 java.lang.String functionName
          (Required) The name of the stored procedure.
 java.lang.String name
          (Required) Unique name that references this stored procedure query.
 PLSQLParameter returnParameter
          (Required) Defines the return value of the stored function.
 
Optional Element Summary
 QueryHint[] hints
          (Optional) Query hints.
 PLSQLParameter[] parameters
          (Optional) Defines the parameters to the stored procedure.
 java.lang.String resultSetMapping
          (Optional) The name of the SQLResultMapping.
 

Element Detail

name

public abstract java.lang.String name
(Required) Unique name that references this stored procedure query.


functionName

public abstract java.lang.String functionName
(Required) The name of the stored procedure.


returnParameter

public abstract PLSQLParameter returnParameter
(Required) Defines the return value of the stored function.

hints

public abstract QueryHint[] hints
(Optional) Query hints.

Default:
{}

resultSetMapping

public abstract java.lang.String resultSetMapping
(Optional) The name of the SQLResultMapping.

Default:
""

parameters

public abstract PLSQLParameter[] parameters
(Optional) Defines the parameters to the stored procedure.

Default:
{}

EclipseLink 2.3.2, build 'v20111125-r10461' API Reference