Java Persistence API (JPA) Extensions Reference for EclipseLink, Release 2.5
  Go To Table Of Contents
 Search
 PDFComments
Comments


@StoredProcedureParameter

Use @StoredProcedureParameter within a NamedStoredProcedureQuery annotation.


Annotation Elements

Table 2-63 describes this annotation's elements.

Table 2-63 @StoredProcedureParameter Annotation Elements

Annotation Element Description Default

queryParameter

(Required) The query parameter name


direction

(Optional) The direction of the stored procedure parameter:

  • IN – Input parameter

  • IN_OUT – Input and output parameters

  • OUT – Output parameter

  • OUT_CURSOR – Output cursor

IN

jdbcType

(Optional) JDBC type code. This depends on the type returned from the procedure.

-1

jdbcTypeName

(Optional) JDBC type name. This may be required for ARRAY or STRUCT types.


name

(Optional) Stored procedure parameter name


optional

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

false

type

(Optional) Type of Java class desired back from the procedure. This depends on the type returned from the procedure.

void.class



Examples

See "@NamedStoredProcedureQuery" for an example using the @StoredProcedureParameter annotation.


See Also

For more information: