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

Required Elements

Modifier and Type	Required Element and Description
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

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.
QueryHint[]	hints (Optional) Query hints.
boolean	multipleResultSets (Optional) Defines if the stored procedure returns multiple result sets.
StoredProcedureParameter[]	parameters (Optional) Defines the parameters to the stored procedure.
java.lang.Class	resultClass Deprecated.
java.lang.Class[]	resultClasses (Optional) Refers to the classes of the result.
java.lang.String	resultSetMapping Deprecated.
java.lang.String[]	resultSetMappings (Optional) The names of the SQLResultMappings.
boolean	returnsResultSet (Optional) Defines if stored procedure returns 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

Deprecated.

(Optional) Refers to the class of the result.

See Also:

resultClasses

Default:

void.class

resultClasses

public abstract java.lang.Class[] resultClasses

(Optional) Refers to the classes of the result.

Default:

{}

resultSetMapping

public abstract java.lang.String resultSetMapping

Deprecated.

(Optional) The name of the SQLResultMapping.

See Also:

resultSetMappings

Default:

""

resultSetMappings

public abstract java.lang.String[] resultSetMappings

(Optional) The names of the SQLResultMappings.

Default:

{}

returnsResultSet

public abstract boolean returnsResultSet

(Optional) Defines if stored procedure returns a result set. This is only relevant on databases that support returning result sets from stored procedures.

Default:

false

multipleResultSets

public abstract boolean multipleResultSets

(Optional) Defines if the stored procedure returns multiple result sets. This is only relevant on databases that support multiple result sets from stored procedures.

Default:

false

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 procedure.

Default:

{}