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

Annotation Type PLSQLParameter

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

  • Required Element Summary

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

  • Optional Element Summary

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

  • Element Details

    • name

      String name
      (Required) Stored procedure parameter name.

    • direction

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

    • queryParameter

      String queryParameter
      (Optional) The query parameter name.
      Default:
      ""

    • optional

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

    • databaseType

      String databaseType
      (Optional) The database data-type for the paramter. This 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
      (Optional) The max length of the field value.
      Default:
      255

    • scale

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

    • precision

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