Package adalid.core.annotations

Annotation Type EntityTableView

  • @Retention(RUNTIME)
@Target(TYPE)
public @interface EntityTableView
    La anotación EntityTableView se utiliza para controlar la generación de las vistas (páginas) de consulta y/o registro tabular de la entidad, conocidas como Tablas de Consulta y/o Tablas de Registro, respectivamente.
    Author:
    Jorge Campins

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      Kleenean deletes
      deletes indica si las vistas deben permitir, o no, eliminar instancias de la entidad, es decir, eliminar filas de la tabla de la base de datos correspondiente a la entidad.
      Kleenean enabled
      enabled indica si se debe, o no, generar las vistas.
      Kleenean heading
      heading indica si las vistas Maestro/Detalle, donde la entidad es el detalle, muestran, o no, un encabezado con propiedades del maestro.
      String helpDocument
      helpDocument especifica el documento incrustado de ayuda de las vistas (páginas) de consulta y/o registro tabular de la entidad.
      String helpFile
      helpFile especifica la ruta y el nombre del archivo de ayuda de las vistas (páginas) de consulta y/o registro tabular de la entidad.
      Kleenean inserts
      inserts indica si las vistas deben permitir, o no, agregar nuevas instancias de la entidad, es decir, insertar nuevas filas a la tabla de la base de datos correspondiente a la entidad.
      ViewMenuOption menu
      menu especifica el tipo de vistas (páginas) generadas que deben ser accesibles desde el menú principal de la aplicación.
      String readingViewEasternToolbarSnippet
      readingViewEasternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de consulta tabular de la entidad.
      String readingViewHeadSnippet
      readingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de consulta tabular de la entidad.
      String readingViewWesternToolbarSnippet
      readingViewWesternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de consulta tabular de la entidad.
      int rows
      rows específica el número inicial de filas por página que muestra la vista.
      int rowsLimit
      rowsLimit específica el máximo número de filas por página que muestra la vista.
      Kleenean updates
      updates indica si las vistas deben permitir, o no, modificar instancias de la entidad, es decir, actualizar filas de la tabla de la base de datos correspondiente a la entidad.
      String writingViewEasternToolbarSnippet
      writingViewEasternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de registro tabular de la entidad.
      String writingViewHeadSnippet
      writingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de registro tabular de la entidad.
      String writingViewWesternToolbarSnippet
      writingViewWesternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de registro tabular de la entidad.

    • Element Detail

      • enabled

        Kleenean enabled
        enabled indica si se debe, o no, generar las vistas. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para generar las vistas; 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.
        Returns:
        enabled
        Default:
        adalid.core.enums.Kleenean.UNSPECIFIED

      • inserts

        Kleenean inserts
        inserts indica si las vistas deben permitir, o no, agregar nuevas instancias de la entidad, es decir, insertar nuevas filas a la tabla de la base de datos correspondiente a la entidad. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para permitir agregar; 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.
        Returns:
        inserts
        Default:
        adalid.core.enums.Kleenean.UNSPECIFIED

      • updates

        Kleenean updates
        updates indica si las vistas deben permitir, o no, modificar instancias de la entidad, es decir, actualizar filas de la tabla de la base de datos correspondiente a la entidad. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para permitir modificar; 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.
        Returns:
        updates
        Default:
        adalid.core.enums.Kleenean.UNSPECIFIED

      • deletes

        Kleenean deletes
        deletes indica si las vistas deben permitir, o no, eliminar instancias de la entidad, es decir, eliminar filas de la tabla de la base de datos correspondiente a la entidad. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para permitir eliminar; 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.
        Returns:
        deletes
        Default:
        adalid.core.enums.Kleenean.UNSPECIFIED

      • heading

        Kleenean heading
        heading indica si las vistas Maestro/Detalle, donde la entidad es el detalle, muestran, o no, un encabezado con propiedades del maestro. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para mostrar el encabezado; 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.
        Returns:
        heading
        Default:
        adalid.core.enums.Kleenean.UNSPECIFIED

      • rowsLimit

        int rowsLimit
        rowsLimit específica el máximo número de filas por página que muestra la vista. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor debe ser un número entero entre 5 y 1000. El valor predeterminado es 100.
        Returns:
        rowsLimit
        Default:
        100

      • rows

        int rows
        rows específica el número inicial de filas por página que muestra la vista. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento enabled es TRUE. Su valor debe ser un número entero entre 1 y el valor del elemento rowsLimit. El valor predeterminado es 10
        Returns:
        rows
        Default:
        10

      • menu

        ViewMenuOption menu
        menu especifica el tipo de vistas (páginas) generadas que deben ser accesibles desde el menú principal de la aplicación. Su valor es uno de los elementos de la enumeración ViewMenuOption. Seleccione ALL para agregar una opción de menú para todas las vistas generadas, sin importar su tipo. Seleccione READING o WRITING para agregar una opción solo para las vistas de consulta o las de registro, respectivamente. Seleccione NONE para no agregar opciones de menú para las vistas generadas. El valor predeterminado del atributo es ALL.
        Returns:
        menu
        Default:
        adalid.core.enums.ViewMenuOption.ALL

      • helpDocument

        String helpDocument
        helpDocument especifica el documento incrustado de ayuda de las vistas (páginas) de consulta y/o registro tabular de la entidad. Si utiliza la plataforma jee2, puede ser una URL o un iframe que incluya la URL del documento. Las vistas utilizarán el documento incrustado definido para el correspondiente formato de vista de la entidad, la entidad de la vista, el módulo al que pertenece la entidad de la vista o el proyecto maestro, buscando en ese orden; si ninguno de ellos está definido, no habrá un documento incrustado disponible para la vista.
        Returns:
        helpDocument
        Default:
        ""

      • helpFile

        String helpFile
        helpFile especifica la ruta y el nombre del archivo de ayuda de las vistas (páginas) de consulta y/o registro tabular de la entidad. Si utiliza la plataforma jee2, la ruta del archivo debe ser relativa al subdirectorio especificado mediante el atributo extraordinario HELP_RESOURCES_FOLDER del proyecto maestro, y cuyo valor por omisión es el subdirectorio resources/help/custom-made del directorio src/main/webapp del módulo Web de la aplicación. Cada vista de la entidad podría tener su propio archivo de ayuda, según lo establecido mediante el elemento helpFileAutoName de la anotación EntityClass. La vista que no tenga su propio archivo de ayuda utilizará el definido para el correspondiente formato de vista de la entidad, la entidad de la vista, el módulo al que pertenece la entidad de la vista o el proyecto maestro, buscando en ese orden; si ninguno de ellos está definido, la página de ayuda no estará disponible para la vista.
        Returns:
        helpFile
        Default:
        ""

      • readingViewHeadSnippet

        String readingViewHeadSnippet
        readingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de consulta tabular de la entidad. 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:
        readingViewHeadSnippet
        Default:
        ""

      • readingViewEasternToolbarSnippet

        String readingViewEasternToolbarSnippet
        readingViewEasternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de consulta tabular de la entidad. 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:
        readingViewEasternToolbarSnippet
        Default:
        ""

      • readingViewWesternToolbarSnippet

        String readingViewWesternToolbarSnippet
        readingViewWesternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de consulta tabular de la entidad. 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:
        readingViewWesternToolbarSnippet
        Default:
        ""

      • writingViewHeadSnippet

        String writingViewHeadSnippet
        writingViewHeadSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de registro tabular de la entidad. 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:
        writingViewHeadSnippet
        Default:
        ""

      • writingViewEasternToolbarSnippet

        String writingViewEasternToolbarSnippet
        writingViewEasternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de registro tabular de la entidad. 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:
        writingViewEasternToolbarSnippet
        Default:
        ""

      • writingViewWesternToolbarSnippet

        String writingViewWesternToolbarSnippet
        writingViewWesternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de registro tabular de la entidad. 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:
        writingViewWesternToolbarSnippet
        Default:
        ""