Top Description Methods

org.eclipse.persistence.annotations

public @Interface NamedStoredFunctionQuery

Annotations

extends Annotation

@Target:TYPE
@Retention:RUNTIME
@Repeatable:NamedStoredFunctionQueries

Imports

java.lang.annotation.Retention, .Target, .Repeatable, jakarta.persistence.QueryHint

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

Method Summary

Modifier and Type	Method and Description
public boolean	callByIndex() (Optional) Defines if the stored procedure should be called by index or by name.
public String	functionName() (Required) The name of the stored function.
public QueryHint[]	hints() (Optional) Query hints.
public String	name() (Required) Unique name that references this stored function query.
public StoredProcedureParameter[]	parameters() (Optional) Defines the parameters to the stored function.
public String	resultSetMapping() (Optional) The name of the SQLResultMapping.
public StoredProcedureParameter	returnParameter() (Required) Defines the return value of the stored function.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

callByIndex	back to summary
public 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.

functionName	back to summary
public String functionName() (Required) The name of the stored function.

hints	back to summary
public QueryHint[] hints() (Optional) Query hints.

name	back to summary
public String name() (Required) Unique name that references this stored function query.

parameters	back to summary
public StoredProcedureParameter[] parameters() (Optional) Defines the parameters to the stored function.

resultSetMapping	back to summary
public String resultSetMapping() (Optional) The name of the SQLResultMapping.

returnParameter	back to summary
public StoredProcedureParameter returnParameter() (Required) Defines the return value of the stored function.