Package adalid.core.annotations

Annotation Interface EntityConsoleView

@Retention(RUNTIME) @Target(TYPE) public @interface EntityConsoleView
La anotación EntityConsoleView se utiliza para controlar la generación de las vistas (páginas) de ejecución de operaciones de negocio de la entidad, conocidas como Consolas de Procesamiento.
Author:
Jorge Campins

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    aboveProcessingPanelSnippet
    aboveProcessingPanelSnippet especifica la ruta y el nombre del snippet ubicado encima del panel de procesamiento en las vistas (páginas) de ejecución de operaciones de negocio de la entidad.
    String
    belowProcessingPanelSnippet
    belowProcessingPanelSnippet especifica la ruta y el nombre del snippet ubicado debajo del panel de procesamiento en las vistas (páginas) de ejecución de operaciones de negocio de la entidad.
    String
    easternToolbarSnippet
    easternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de ejecución de operaciones de negocio de la entidad.
    Kleenean
    enabled
    enabled indica si se debe, o no, generar las vistas.
    String
    headSnippet
    headSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de ejecución de operaciones de negocio de la entidad.
    String
    helpDocument
    helpDocument especifica el documento incrustado de ayuda de las vistas (páginas) de ejecución de operaciones de negocio de la entidad.
    String
    helpFile
    helpFile especifica la ruta y el nombre del archivo de ayuda de las vistas (páginas) de ejecución de operaciones de negocio de la entidad.
    Kleenean
    menu
    menu indica si las vistas (páginas) generadas deben ser, o no, accesibles desde el menú principal de la aplicación.
    String
    westernToolbarSnippet
    westernToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de ejecución de operaciones de negocio de la entidad.

  • Element Details

    • 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 si la entidad no es una enumeración y tiene al menos una operación de negocio definida; en caso contrario es FALSE.
      Returns:
      enabled
      Default:
      UNSPECIFIED

    • helpDocument

      String helpDocument
      helpDocument especifica el documento incrustado de ayuda de las vistas (páginas) de ejecución de operaciones de negocio 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 ejecución de operaciones de negocio 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:
      ""

    • headSnippet

      String headSnippet
      headSnippet especifica la ruta y el nombre del snippet del encabezado en las vistas (páginas) de ejecución de operaciones de negocio 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:
      headSnippet
      Default:
      ""

    • easternToolbarSnippet

      String easternToolbarSnippet
      easternToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción oriental en las vistas (páginas) de ejecución de operaciones de negocio 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:
      easternToolbarSnippet
      Default:
      ""

    • westernToolbarSnippet

      String westernToolbarSnippet
      westernToolbarSnippet especifica la ruta y el nombre del snippet de la barra de botones de acción occidental en las vistas (páginas) de ejecución de operaciones de negocio 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:
      westernToolbarSnippet
      Default:
      ""

    • aboveProcessingPanelSnippet

      String aboveProcessingPanelSnippet
      aboveProcessingPanelSnippet especifica la ruta y el nombre del snippet ubicado encima del panel de procesamiento en las vistas (páginas) de ejecución de operaciones de negocio 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:
      aboveProcessingPanelSnippet
      Default:
      ""

    • belowProcessingPanelSnippet

      String belowProcessingPanelSnippet
      belowProcessingPanelSnippet especifica la ruta y el nombre del snippet ubicado debajo del panel de procesamiento en las vistas (páginas) de ejecución de operaciones de negocio 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:
      belowProcessingPanelSnippet
      Default:
      ""