Module eclipselink
Package org.eclipse.persistence.platform.database.oracle.annotations

Annotation Interface PLSQLParameter

@Target({}) @Retention(RUNTIME) public @interface PLSQLParameter
A PLSQLParameter annotation is used within a NamedPLSQLStoredProcedureQuery, NamedPLSQLStoredFunctionQuery, OracleObject or PLSQLRecord annotation.
See Also:
Author:
James Sutherland

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    Stored procedure parameter name.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    databaseType
    The database data-type for the parameter.
    Direction
    direction
    The direction of the stored procedure parameter.
    int
    length
    The max length of the field value.
    boolean
    optional
    Define if the parameter is required, or optional and defaulted by the procedure.
    int
    precision
    If a numeric, the max precision value.
    String
    queryParameter
    The query parameter name.
    int
    scale
    If a numeric, the max scale value.

  • Element Details

    • direction

      Direction direction
      The direction of the stored procedure parameter.
      Default:
      IN

    • name

      String name
      Stored procedure parameter name.

    • queryParameter

      String queryParameter
      The query parameter name.
      Default:
      ""

    • optional

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

    • databaseType

      String databaseType
      The database data-type for the parameter.

      This is either one of the type constants defined in OraclePLSQLTypes, or JDBCTypes, or a custom record or table type name.

      See Also:
      Default:
      "VARCHAR_TYPE"

    • length

      int length
      The max length of the field value.
      Default:
      255

    • scale

      int scale
      If a numeric, the max scale value.
      Default:
      0

    • precision

      int precision
      If a numeric, the max precision value.
      Default:
      0