Package adalid.core.annotations

Annotation Interface EntityCollectionField

@Retention(RUNTIME) @Target(FIELD) public @interface EntityCollectionField
La anotación EntityCollectionField se utiliza para establecer atributos de colecciones (propiedades EntityCollection).
Author:
Jorge Campins

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    PropertyAccess
    access
    access especifica el tipo de control de acceso de la colección.
    String
    afterReadingSnippet
    afterReadingSnippet especifica la ruta y el nombre del snippet que se encuentra después de la colección de lectura en vistas (páginas) de consulta y registro.
    String
    afterWritingSnippet
    afterWritingSnippet especifica la ruta y el nombre del snippet que se encuentra después de la colección de escritura en vistas (páginas) de registro.
    String
    beforeReadingSnippet
    beforeReadingSnippet especifica la ruta y el nombre del snippet que se encuentra antes de la colección de lectura en vistas (páginas) de consulta y registro.
    String
    beforeWritingSnippet
    beforeWritingSnippet especifica la ruta y el nombre del snippet que se encuentra antes de la colección de escritura en vistas (páginas) de registro.
    Kleenean
    create
    create indica si la colección es, o no, requerida por la operación insert de las vistas (páginas) de registro.
    Kleenean
    detail
    detail indica si la colección es, o no, visible en las vistas (páginas) de consulta y registro detallado.
    DataEntryFormat
    format
    format especifica el orden de búsqueda de la vista (página) para entrada de datos de la colección.
    InlineHelpType
    inlineHelp
    inlineHelp especifica el atributo de la colección que se debe utilizar como ayuda en línea.
    String
    readingViewRowActionSnippet
    readingViewRowActionSnippet especifica la ruta y el nombre del snippet de la columna de botones de acción de las filas de la colección en vistas (páginas) de consulta.
    String
    readingViewRowNumberSnippet
    readingViewRowNumberSnippet especifica la ruta y el nombre del snippet de la columna de números de secuencia de las filas de la colección en vistas (páginas) de consulta.
    String
    readingViewRowStatusSnippet
    readingViewRowStatusSnippet especifica la ruta y el nombre del snippet de la columna de iconos de estado de las filas de la colección en vistas (páginas) de consulta.
    Kleenean
    update
    update indica si la colección es, o no, requerida por la operación update de las vistas (páginas) de registro.
    String
    writingViewRowActionSnippet
    writingViewRowActionSnippet especifica la ruta y el nombre del snippet de la columna de botones de acción de las filas de la colección en vistas (páginas) de registro.
    String
    writingViewRowNumberSnippet
    writingViewRowNumberSnippet especifica la ruta y el nombre del snippet de la columna de números de secuencia de las filas de la colección en vistas (páginas) de registro.
    String
    writingViewRowStatusSnippet
    writingViewRowStatusSnippet especifica la ruta y el nombre del snippet de la columna de iconos de estado de las filas de la colección en vistas (páginas) de registro.

  • Element Details

    • access

      PropertyAccess access
      access especifica el tipo de control de acceso de la colección. Su valor es uno de los elementos de la enumeración PropertyAccess. Seleccione RESTRICTED_WRITING o RESTRICTED_READING para especificar acceso restringido de escritura o lectura, respectivamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED para especificar acceso no restringido.
      Returns:
      access
      Default:
      UNSPECIFIED

    • format

      DataEntryFormat format
      format especifica el orden de búsqueda de la vista (página) para entrada de datos de la colección. Su valor es uno de los elementos de la enumeración DataEntryFormat. Seleccione DETAIL_OR_TABLE o TABLE_OR_DETAIL para buscar primero la vista de formato detallado o tabular, respectivamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es DETAIL_OR_TABLE.
      Returns:
      format
      Default:
      UNSPECIFIED

    • create

      Kleenean create
      create indica si la colección es, o no, requerida por la operación insert de las vistas (páginas) de registro. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento cascade de la anotación OneToMany de la colección es ALL o incluye PERSIST. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si la colección es requerida por la operación insert; en caso contrario, seleccione FALSE. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es TRUE si el elemento cascade de la anotación OneToMany de la colección incluye PERSIST; en caso contrario es FALSE.
      Returns:
      create
      Default:
      UNSPECIFIED

    • update

      Kleenean update
      update indica si la colección es, o no, requerida por la operación update de las vistas (páginas) de registro. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento cascade de la anotación OneToMany de la colección es ALL o incluye MERGE. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si la colección es requerida por la operación update; en caso contrario, seleccione FALSE. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es TRUE si el elemento cascade de la anotación OneToMany de la colección incluye MERGE; en caso contrario es FALSE.
      Returns:
      update
      Default:
      UNSPECIFIED

    • detail

      Kleenean detail
      detail indica si la colección es, o no, visible en las vistas (páginas) de consulta y registro detallado. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento cascade de la anotación OneToMany de la colección es ALL o incluye REFRESH. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si la colección es visible; en caso contrario, seleccione FALSE. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es TRUE si el elemento cascade de la anotación OneToMany de la colección incluye REFRESH; en caso contrario es FALSE.
      Returns:
      detail
      Default:
      UNSPECIFIED

    • inlineHelp

      InlineHelpType inlineHelp
      inlineHelp especifica el atributo de la colección que se debe utilizar como ayuda en línea. Su valor es uno de los elementos de la enumeración InlineHelpType. Seleccione SHORT_DESCRIPTION para utilizar la descripción corta de la colección, establecida con el método setDefaultShortDescription o con el método setLocalizedShortDescription. Seleccione DESCRIPTION para utilizar la descripción corta de la colección, si ésta fue establecida; o, de lo contrario, la descripción de la colección, establecida con el método setDefaultDescription o con el método setLocalizedDescription. Seleccione NONE si desea que la colección no tenga ayuda en línea. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es DESCRIPTION.
      Returns:
      access
      Default:
      UNSPECIFIED

    • afterReadingSnippet

      String afterReadingSnippet
      afterReadingSnippet especifica la ruta y el nombre del snippet que se encuentra después de la colección de lectura en vistas (páginas) de consulta y registro. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      afterReadingSnippet
      Default:
      ""

    • afterWritingSnippet

      String afterWritingSnippet
      afterWritingSnippet especifica la ruta y el nombre del snippet que se encuentra después de la colección de escritura en vistas (páginas) de registro. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      afterWritingSnippet
      Default:
      ""

    • beforeReadingSnippet

      String beforeReadingSnippet
      beforeReadingSnippet especifica la ruta y el nombre del snippet que se encuentra antes de la colección de lectura en vistas (páginas) de consulta y registro. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      beforeReadingSnippet
      Default:
      ""

    • beforeWritingSnippet

      String beforeWritingSnippet
      beforeWritingSnippet especifica la ruta y el nombre del snippet que se encuentra antes de la colección de escritura en vistas (páginas) de registro. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      beforeWritingSnippet
      Default:
      ""

    • readingViewRowActionSnippet

      String readingViewRowActionSnippet
      readingViewRowActionSnippet especifica la ruta y el nombre del snippet de la columna de botones de acción de las filas de la colección en vistas (páginas) de consulta. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      readingViewRowActionSnippet
      Default:
      ""

    • readingViewRowStatusSnippet

      String readingViewRowStatusSnippet
      readingViewRowStatusSnippet especifica la ruta y el nombre del snippet de la columna de iconos de estado de las filas de la colección en vistas (páginas) de consulta. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      readingViewRowStatusSnippet
      Default:
      ""

    • readingViewRowNumberSnippet

      String readingViewRowNumberSnippet
      readingViewRowNumberSnippet especifica la ruta y el nombre del snippet de la columna de números de secuencia de las filas de la colección en vistas (páginas) de consulta. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      readingViewRowNumberSnippet
      Default:
      ""

    • writingViewRowActionSnippet

      String writingViewRowActionSnippet
      writingViewRowActionSnippet especifica la ruta y el nombre del snippet de la columna de botones de acción de las filas de la colección en vistas (páginas) de registro. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      writingViewRowActionSnippet
      Default:
      ""

    • writingViewRowStatusSnippet

      String writingViewRowStatusSnippet
      writingViewRowStatusSnippet especifica la ruta y el nombre del snippet de la columna de iconos de estado de las filas de la colección en vistas (páginas) de registro. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      writingViewRowStatusSnippet
      Default:
      ""

    • writingViewRowNumberSnippet

      String writingViewRowNumberSnippet
      writingViewRowNumberSnippet especifica la ruta y el nombre del snippet de la columna de números de secuencia de las filas de la colección en vistas (páginas) de registro. Si utiliza la plataforma jee2, los snippets se deben agregar en el subdirectorio resources/snippets/custom-made del directorio src/main/webapp del módulo Web, o en algún subdirectorio de resources/snippets/custom-made; si el valor de snippet no comienza por /resources/snippets/custom-made/, ese prefijo se le agrega automáticamente. Además, los snippets deben ser archivos xhtml; si el valor de snippet no termina con .xhtml, ese sufijo se le agrega automáticamente.
      Returns:
      writingViewRowNumberSnippet
      Default:
      ""