Package adalid.core.annotations

Annotation Type EntityClass

  • @Retention(RUNTIME)
@Target(TYPE)
public @interface EntityClass
    La anotación EntityClass se utiliza para establecer atributos básicos de la entidad.
    Author:
    Jorge Campins

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      Kleenean base
      base indica si la entidad es, o no, una entidad de la base operativa de la aplicación.
      Kleenean catalog
      catalog indica si la entidad es, o no, una entidad del catálogo de la aplicación.
      String collectionName
      collectionName especifica el nombre de colección de la entidad
      String helpDocument
      helpDocument especifica el documento incrustado de ayuda de la entidad.
      String helpFile
      helpFile especifica la ruta y el nombre del archivo de ayuda de la entidad.
      HelpFileAutoName helpFileAutoName
      helpFileAutoName especifica el método de generación automática del nombre del archivo de ayuda de las vistas (páginas) de la entidad.
      String helpFileAutoType
      helpFileAutoType especifica el tipo (la extensión sin el punto) de los nombres de archivo de ayuda generados automáticamente.
      Kleenean independent
      independent indica si la entidad es, o no, existencialmente independiente.
      ResourceGender resourceGender
      resourceGender especifica el género gramatical de la entidad.
      ResourceType resourceType
      resourceType especifica el tipo de recurso de la entidad.
      int startWith
      startWith específica el valor de la clave primaria de la primera instancia definida en la meta entidad.
      Kleenean variant
      variant indica si la entidad es, o no, una entidad variante.
      EntityViewType viewType
      viewType especifica el tipo de vistas permitido para la entidad.

    • Element Detail

      • base

        Kleenean base
        base indica si la entidad es, o no, una entidad de la base operativa de la aplicación. La base operativa es el conjunto de entidades necesarias para la prestación de los servicios básicos de la aplicación. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si la entidad es una entidad de la base operativa; 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 FALSE.
        Returns:
        base
        Default:
        adalid.core.enums.Kleenean.UNSPECIFIED

      • catalog

        Kleenean catalog
        catalog indica si la entidad es, o no, una entidad del catálogo de la aplicación. El catálogo es el conjunto de entidades de configuración básica (netadata) de la aplicación. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si la entidad es una entidad del catálogo; 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 FALSE.
        Returns:
        catalog
        Default:
        adalid.core.enums.Kleenean.UNSPECIFIED

      • independent

        Kleenean independent
        independent indica si la entidad es, o no, existencialmente independiente. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si la entidad es existencialmente independiente; 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:
        independent
        Default:
        adalid.core.enums.Kleenean.UNSPECIFIED

      • viewType

        EntityViewType viewType
        viewType especifica el tipo de vistas permitido para la entidad. Su valor es uno de los elementos de la enumeración EntityViewType. Seleccione INDEPENDENT, MASTER_DETAIL o BOTH para permitir la generación de vistas independientes, maestro/detalle o ambas, respectivamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es INDEPENDENT si la entidad es una enumeración; de lo contrario, BOTH.
        Returns:
        viewType
        Default:
        adalid.core.enums.EntityViewType.UNSPECIFIED

      • variant

        Kleenean variant
        variant indica si la entidad es, o no, una entidad variante. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si la entidad es variante; 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 FALSE.
        Returns:
        variant
        Default:
        adalid.core.enums.Kleenean.UNSPECIFIED

      • resourceType

        ResourceType resourceType
        resourceType especifica el tipo de recurso de la entidad. Su valor es uno de los elementos de la enumeración ResourceType. Seleccione CONFIGURATION, TESTING u OPERATION si la entidad es de configuración, prueba u operación, respectivamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED si el tipo de recurso es indeterminado.
        Returns:
        resourceType
        Default:
        adalid.core.enums.ResourceType.UNSPECIFIED

      • resourceGender

        ResourceGender resourceGender
        resourceGender especifica el género gramatical de la entidad. Su valor es uno de los elementos de la enumeración ResourceGender. Seleccione MASCULINE, FEMININE, COMMON o NEUTER si la entidad es de género masculino, femenino, común o neutro, respectivamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado es NEUTER.
        Returns:
        resourceGender
        Default:
        adalid.core.enums.ResourceGender.UNSPECIFIED

      • collectionName

        String collectionName
        collectionName especifica el nombre de colección de la entidad
        Returns:
        collectionName
        Default:
        ""

      • helpDocument

        String helpDocument
        helpDocument especifica el documento incrustado de ayuda de la entidad. Si utiliza la plataforma jee2, puede ser una URL o un iframe que incluya la URL del documento. También se puede especificar un documento incrustado diferente para cada formato de vista de la entidad, mediante las anotaciones EntityTableView, EntityDetailView, EntityTreeView y EntityConsoleView. 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 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 (página) de la entidad podría tener su propio archivo de ayuda, según lo establecido mediante el elemento helpFileAutoName. También se puede especificar un archivo diferente para cada formato de vista de la entidad, mediante las anotaciones EntityTableView, EntityDetailView, EntityTreeView y EntityConsoleView. 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:
        ""

      • helpFileAutoName

        HelpFileAutoName helpFileAutoName
        helpFileAutoName especifica el método de generación automática del nombre del archivo de ayuda de las vistas (páginas) de la entidad. Su valor es uno de los elementos de la enumeración HelpFileAutoName. Seleccione DISPLAY o ENTITY para que generar automáticamente el nombre del archivo de ayuda de las vistas con el nombre de la vista o con el de la entidad de la vista, respectivamente; alternativamente, omita el elemento o seleccione NONE para utilizar el valor predeterminado del atributo. Seleccione ENTITY para utilizar los archivos de ayuda generados por la clase utilitaria WebAppHelp. El valor predeterminado del atributo es el valor del elemento helpFileAutoName de la anotación ProjectModule del módulo al que pertenece la entidad.
        Returns:
        helpFileAutoName
        Default:
        adalid.core.enums.HelpFileAutoName.UNSPECIFIED

      • helpFileAutoType

        String helpFileAutoType
        helpFileAutoType especifica el tipo (la extensión sin el punto) de los nombres de archivo de ayuda generados automáticamente. Este elemento es relevante solo si el valor especificado, o determinado, para el elemento helpFileAutoName es DISPLAY o ENTITY. Su valor puede ser html, xhtml, pdf, gif, jpg, jpeg o png. Especifique xhtml para utilizar los archivos de ayuda generados por la clase utilitaria WebAppHelp. El valor predeterminado del atributo es el valor del elemento helpFileAutoType de la anotación ProjectModule del módulo al que pertenece la entidad.
        Returns:
        helpFileAutoType
        Default:
        ""

      • startWith

        int startWith
        startWith específica el valor de la clave primaria de la primera instancia definida en la meta entidad. Su valor debe ser un número entero entre 0 y 2.147.483.647. El valor predeterminado es 1.
        Returns:
        startWith
        Default:
        1