Module eclipselink
Package org.eclipse.persistence.annotations

Annotation Interface StoredProcedureParameter

@Target({}) @Retention(RUNTIME) public @interface StoredProcedureParameter
A StoredProcedureParameter annotation is used within a NamedStoredProcedureQuery and NamedStoredFunctionQuery annotation.
See Also:
Author:
Guy Pelletier

  • Required Element Summary

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

  • Optional Element Summary

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

  • Element Details

    • direction

      @Deprecated Direction direction
      Deprecated.
      Use mode().
      The direction of the stored procedure parameter.
      Default:
      IN

    • mode

      jakarta.persistence.ParameterMode mode
      The direction of the stored procedure parameter.
      Default:
      IN

    • name

      String name
      Stored procedure parameter name.
      Default:
      ""

    • queryParameter

      String queryParameter
      The query parameter name.

    • optional

      boolean optional
      Define if the parameter is required, or optional and defaulted by the procedure.
      Default:
      false

    • type

      Class<?> type
      The type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.
      Default:
      void.class

    • jdbcType

      int jdbcType
      The JDBC type code, this is dependent on the type returned from the procedure.
      Default:
      -1

    • jdbcTypeName

      String jdbcTypeName
      The JDBC type name, this may be required for ARRAY or STRUCT types.
      Default:
      ""