org.eclipse.persistence.annotations
Annotation Type NamedStoredProcedureQuery

@Target(value=TYPE)
@Retention(value=RUNTIME)
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:

org.eclipse.persistence.annotations.StoredProcedureParameter.

Author:

Guy Pelletier

Since:

Oracle TopLink 11.1.1.0.0

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

QueryHint[]	hints (Optional) Query hints.
StoredProcedureParameter[]	parameters (Optional) Defines arguments 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.
boolean	returnsResultSet (Optional) Whether the query should return a result set.

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

""

returnsResultSet

public abstract boolean returnsResultSet

(Optional) Whether the query should return a result set. You should only set this flag to true if you expect a raw JDBC ResultSet to be returned from your stored proceduce. Otherwise, you should let the default apply.

Default:

false

parameters

public abstract StoredProcedureParameter[] parameters

(Optional) Defines arguments to the stored procedure.

Default:

{}