Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle TopLink
11g Release 1 (11.1.1)

E28847-01


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


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

A PLSQLNamedStoredProcedureQuery annotation allows the definition of queries that call PLSQL stored procedures 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 PLSQLNamedStoredProcedureQuery annotation may be defined on an Entity or MappedSuperclass.

Since:
EclipseLink 2.3
Author:
James Sutherland

Required Element Summary
 java.lang.String name
          (Required) Unique name that references this stored procedure query.
 java.lang.String procedureName
          (Required) The name of the stored procedure.

 

Optional Element Summary
 javax.persistence.QueryHint[] hints
          (Optional) Query hints.
 PLSQLParameter[] parameters
          (Optional) Defines the parameters to the stored procedure.
 java.lang.Class resultClass
          (Optional) Refers to the class of the result.
 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.

procedureName

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

hints

public abstract javax.persistence.QueryHint[] hints
(Optional) Query hints.
Default:
{}

resultClass

public abstract java.lang.Class resultClass
(Optional) Refers to the class of the result.
Default:
void.class

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:
{}

Skip navigation links

Copyright © 1998, 2012, Oracle. All Rights Reserved.