org.eclipse.persistence.annotations

Annotation Type StoredProcedureParameter

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

A StoredProcedureParameter annotation is used within a NamedStoredProcedureQuery annotation.

See Also:

NamedStoredProcedureQuery

Author:

Guy Pelletier

Since:

Oracle TopLink 11.1.1.0.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	queryParameter (Required) The query parameter name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Direction	direction Deprecated.
int	jdbcType (Optional) The JDBC type code, this is dependent on the type returned from the procedure.
String	jdbcTypeName (Optional) The JDBC type name, this may be required for ARRAY or STRUCT types.
jakarta.persistence.ParameterMode	mode (Optional) The direction of the stored procedure parameter.
String	name (Optional) Stored procedure parameter name.
boolean	optional (Optional) Define if the parameter is required, or optional and defaulted by the procedure.
Class	type (Optional) The type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

Element Detail

queryParameter

public abstract String queryParameter

(Required) The query parameter name.

direction

public abstract Direction direction

Deprecated.

(Optional) The direction of the stored procedure parameter.

See Also:

mode()

Default:

org.eclipse.persistence.annotations.Direction.IN

mode

public abstract jakarta.persistence.ParameterMode mode

(Optional) The direction of the stored procedure parameter.

Default:

jakarta.persistence.ParameterMode.IN

name

public abstract String name

(Optional) Stored procedure parameter name.

Default:

""

optional

public abstract boolean optional

(Optional) Define if the parameter is required, or optional and defaulted by the procedure.

Default:

false

type

public abstract Class type

(Optional) The type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.

Default:

void.class

jdbcType

public abstract int jdbcType

(Optional) The JDBC type code, this is dependent on the type returned from the procedure.

Default:

-1

jdbcTypeName

public abstract String jdbcTypeName

(Optional) The JDBC type name, this may be required for ARRAY or STRUCT types.

Default:

""