jakarta.persistence

Annotation Type StoredProcedureParameter

@Target(value={})
 @Retention(value=RUNTIME)
public @interface StoredProcedureParameter

Specifies a parameter of a named stored procedure query. All parameters of a named stored procedure query must be specified.

Since:

2.1

See Also:

NamedStoredProcedureQuery, ParameterMode

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class	type JDBC type of the paramter.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
ParameterMode	mode Specifies whether the parameter is an IN, INOUT, OUT, or REF_CURSOR parameter.
String	name The name of the parameter as defined by the stored procedure in the database.

Element Detail

type

public abstract Class type

JDBC type of the paramter.

name

public abstract String name

The name of the parameter as defined by the stored procedure in the database. If a name is not specified, it is assumed that the stored procedure uses positional parameters.

Default:

""

mode

public abstract ParameterMode mode

Specifies whether the parameter is an IN, INOUT, OUT, or REF_CURSOR parameter. REF_CURSOR parameters are used by some databases to return result sets from a stored procedure.

Default:

jakarta.persistence.ParameterMode.IN