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

Annotation Type PLSQLRecord

  • @Target(TYPE)
@Retention(RUNTIME)
public @interface PLSQLRecord
    A PLSQLRecord annotation is used to define a database PLSQL RECORD type. This type can be used within PLSQL procedure calls.
    See Also:
    NamedPLSQLStoredProcedureQuery
    Author:
    James Sutherland
    Since:
    EclipseLink 2.3

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String compatibleType
      (Required) The name of the database OBJECT TYPE that mirrors the record's structure.
      PLSQLParameter[] fields
      (Required) Defines the fields in the record type.
      java.lang.String name
      (Required) The name of the record type in the database.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.Class javaType
      (Optional) The Java class to map the object-type to.

    • Element Detail

      • name

        java.lang.String name
        (Required) The name of the record type in the database.

      • compatibleType

        java.lang.String compatibleType
        (Required) The name of the database OBJECT TYPE that mirrors the record's structure. The record will be converted to/from this type so it can be passed through JDBC.

      • fields

        PLSQLParameter[] fields
        (Required) Defines the fields in the record type.

      • javaType

        java.lang.Class javaType
        (Optional) The Java class to map the object-type to. This class must be mapped using a @Struct annotation.
        Default:
        void.class