org.eclipse.persistence.annotations

Annotation Type NamedStoredFunctionQuery

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Repeatable(value=NamedStoredFunctionQueries.class)
public @interface NamedStoredFunctionQuery

A NamedStoredFunctionQuery annotation allows the definition of queries that call stored functions as named queries. A NamedStoredFunctionQuery annotation may be defined on an Entity or MappedSuperclass.

Author:

James

Since:

EclipseLink 2.3

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	functionName (Required) The name of the stored function.
String	name (Required) Unique name that references this stored function query.
StoredProcedureParameter	returnParameter (Required) Defines the return value of the stored function.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	callByIndex (Optional) Defines if the stored procedure should be called by index or by name.
jakarta.persistence.QueryHint[]	hints (Optional) Query hints.
StoredProcedureParameter[]	parameters (Optional) Defines the parameters to the stored function.
String	resultSetMapping (Optional) The name of the SQLResultMapping.

Element Detail

name

public abstract String name

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

functionName

public abstract String functionName

(Required) The name of the stored function.

returnParameter

public abstract StoredProcedureParameter returnParameter

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

hints

public abstract jakarta.persistence.QueryHint[] hints

(Optional) Query hints.

Default:

{}

resultSetMapping

public abstract String resultSetMapping

(Optional) The name of the SQLResultMapping.

Default:

""

callByIndex

public abstract 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

public abstract StoredProcedureParameter[] parameters

(Optional) Defines the parameters to the stored function.

Default:

{}