org.eclipse.persistence.annotations
Annotation Type StoredProcedureParameter


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

A StoredProcedureParameter annotation is used within a NamedStoredProcedureQuery annotation.

Since:
Oracle TopLink 11.1.1.0.0
Author:
Guy Pelletier
See Also:
NamedStoredProcedureQuery

Required Element Summary
 String queryParameter
          (Required) The query parameter name.
 
Optional Element Summary
 Direction direction
          (Optional) The direction of the stored procedure parameter.
 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.
 String name
          (Optional) Stored procedure parameter name.
 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
(Optional) The direction of the stored procedure parameter.

Default:
org.eclipse.persistence.annotations.Direction.IN

name

public abstract String name
(Optional) Stored procedure parameter name.

Default:
""

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