Annotation Type NamedStoredProcedureQuery
-
@Target(TYPE) @Retention(RUNTIME) @Repeatable(NamedStoredProcedureQueries.class) public @interface NamedStoredProcedureQuery
A NamedStoredProcedureQuery annotation allows the definition of queries that call stored procedures as named queries. A NamedStoredProcedureQuery annotation may be defined on an Entity or MappedSuperclass.- See Also:
StoredProcedureParameter- Author:
- Guy Pelletier
- Since:
- Oracle TopLink 11.1.1.0.0
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description java.lang.Stringname(Required) Unique name that references this stored procedure query.java.lang.StringprocedureName(Required) The name of the stored procedure.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description booleancallByIndex(Optional) Defines if the stored procedure should be called by index or by name.QueryHint[]hints(Optional) Query hints.booleanmultipleResultSets(Optional) Defines if the stored procedure returns multiple result sets.StoredProcedureParameter[]parameters(Optional) Defines the parameters to the stored procedure.java.lang.ClassresultClassDeprecated.java.lang.Class[]resultClasses(Optional) Refers to the classes of the result.java.lang.StringresultSetMappingDeprecated.java.lang.String[]resultSetMappings(Optional) The names of the SQLResultMappings.booleanreturnsResultSet(Optional) Defines if stored procedure returns a result set.
-
-
-
-
hints
QueryHint[] hints
(Optional) Query hints.- Default:
- {}
-
-
-
resultClass
java.lang.Class resultClass
Deprecated.(Optional) Refers to the class of the result.- See Also:
resultClasses()
- Default:
- void.class
-
-
-
resultSetMapping
java.lang.String resultSetMapping
Deprecated.(Optional) The name of the SQLResultMapping.- See Also:
resultSetMappings()
- Default:
- ""
-
-
-
callByIndex
boolean callByIndex
(Optional) Defines if the stored procedure should be called by index or by name. By index requires that the StoredProcedureParameter are defined in the same order as the procedure on the database. By name requires the database platform support naming procedure parameters.- Default:
- false
-
-
-
parameters
StoredProcedureParameter[] parameters
(Optional) Defines the parameters to the stored procedure.- Default:
- {}
-
-