Package adalid.core.annotations

Annotation Interface ParameterField

@Retention(RUNTIME) @Target(FIELD) public @interface ParameterField
La anotación ParameterField se utiliza para establecer atributos básicos del parámetro.
Author:
Jorge Campins

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    anchor
    anchor especifica el nombre de otro parámetro a continuación de la cual se muestra este parámetro en las vistas (páginas) de procesamiento.
    AnchorType
    anchorType
    anchorType especifica el tipo de anclaje del parámetro.
    Kleenean
    auditable
    auditable indica si el parámetro se debe incluir, o no, en las pistas de auditoría de la operación.
    Kleenean
    hidden
    hidden indica si el parámetro permanece, o no, oculto en las vistas (páginas) de ejecución de operaciones de negocio.
    InlineHelpType
    inlineHelp
    inlineHelp especifica el atributo del parámetro que se debe utilizar como ayuda en línea.
    String
    linkedColumn
    linkedColumn especifica el nombre de la columna de la tabla que corresponde a este parámetro.
    String
    linkedField
    linkedField especifica el nombre de la propiedad que corresponde a este parámetro.
    StandardRelationalOp
    operator
    operator especifica el operador escalar de comparación a utilizar.
    Kleenean
    password
    password indica si el parámetro es, o no, una contraseña.
    Kleenean
    required
    required indica si el parámetro es, o no, obligatoriamente requerido por las vistas (páginas) de ejecución de operaciones de negocio.
    int
    sequence
    sequence específica el número de secuencia o posición relativa en la que se muestra el parámetro en las vistas (páginas) de ejecución de operaciones de negocio.
    String
    snippet
    snippet especifica la ruta y el nombre del snippet del parámetro en las vistas (páginas) de ejecución de operaciones de negocio.

  • Element Details

    • auditable

      Kleenean auditable
      auditable indica si el parámetro se debe incluir, o no, en las pistas de auditoría de la operación. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para incluir el parámetro; 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 para parámetros que corresponden a "objetos binarios" o a contraseñas; y TRUE para las demás parámetros.
      Returns:
      auditable
      Default:
      UNSPECIFIED

    • password

      Kleenean password
      password indica si el parámetro es, o no, una contraseña. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si el parámetro es una contraseña; 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:
      password
      Default:
      UNSPECIFIED

    • required

      Kleenean required
      required indica si el parámetro es, o no, obligatoriamente requerido por las vistas (páginas) de ejecución de operaciones de negocio. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si el parámetro es obligatoriamente requerido; 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. Este elemento es irrelevante cuando el parámetro es la referencia a la instancia de la entidad de la operación (vea Anotación InstanceReference); en este caso, el parámetro siempre es requerido.
      Returns:
      required
      Default:
      UNSPECIFIED

    • hidden

      Kleenean hidden
      hidden indica si el parámetro permanece, o no, oculto en las vistas (páginas) de ejecución de operaciones de negocio. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si el parámetro permanece oculta; 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:
      hidden
      Default:
      UNSPECIFIED

    • linkedField

      String linkedField
      linkedField especifica el nombre de la propiedad que corresponde a este parámetro. En operaciones que extiendan la clase ProcessOperation, y estén decoradas con la Anotación ConstructionOperationClass, la función SQL generada inserta una instancia de la entidad especificada mediante el elemento type de ConstructionOperationClass, asignando el valor suministrado para cada parámetro a su propiedad enlazada; por lo tanto, es este caso, la propiedad enlazada debe ser una propiedad de la entidad especificada mediante el elemento type. En operaciones de instancia que extiendan la clase ProcessOperation, y no estén decoradas con la anotación ConstructionOperationClass, la función SQL generada actualiza la instancia identificada por el valor del parámetro de instancia de la operación (parámetro decorado con la Anotación InstanceReference), asignando el valor suministrado para cada parámetro a su propiedad enlazada; por lo tanto, es este caso, la propiedad enlazada debe ser una propiedad de la entidad a la que pertenece la operación. En parámetros de operaciones para generar archivos e informes con consulta dinámica (vea Anotación ExportOperationClass y Anotación ReportOperationClass), el nombre SQL de la propiedad enlazada (vea Método setSqlName) es utilizado como nombre de columna para agregar la correspondiente comparación a la cláusula WHERE de la operación, a menos que también se especifique el elemento linkedColumn de esta misma anotación; por lo tanto, es este caso, la propiedad enlazada debe ser una propiedad de la entidad a la que pertenece la operación.
      Returns:
      linkedField
      Default:
      ""

    • linkedColumn

      String linkedColumn
      linkedColumn especifica el nombre de la columna de la tabla que corresponde a este parámetro. Este elemento es relevante solo para parámetros de operaciones para generar archivos e informes con consulta dinámica (vea Anotación ExportOperationClass y Anotación ReportOperationClass). Este nombre es utilizado para agregar la correspondiente comparación a la cláusula WHERE de la operación.
      Returns:
      linkedColumn
      Default:
      ""

    • operator

      StandardRelationalOp operator
      operator especifica el operador escalar de comparación a utilizar. Su valor es uno de los elementos de la enumeración StandardRelationalOp. El apéndice 2 muestra la comparación correspondiente a cada elemento de la enumeración. El valor predeterminado es EQ. Este elemento es relevante solo para parámetros de operaciones para generar archivos e informes con consulta dinámica (vea Anotación ExportOperationClass y Anotación ReportOperationClass).
      Returns:
      operator
      Default:
      EQ

    • snippet

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

    • anchor

      String anchor
      anchor especifica el nombre de otro parámetro a continuación de la cual se muestra este parámetro en las vistas (páginas) de procesamiento.
      Returns:
      anchor
      Default:
      ""

    • anchorType

      AnchorType anchorType
      anchorType especifica el tipo de anclaje del parámetro. Este elemento es relevante solo si el parámetro está anclado a otro parámetro, usando el elemento anchor. Su valor es uno de los elementos de la enumeración AnchorType. Seleccione UNLINKED para mostrar el parámetro como un elemento contiguo pero independiente de su parámetro ancla. Seleccione BLOCK para mostrar el parámetro conjuntamente con su parámetro ancla, como un elemento de bloque, comenzando en una nueva línea y ocupando todo el ancho disponible. Seleccione INLINE para mostrar el parámetro conjuntamente con su parámetro ancla, como un elemento en línea. Alternativamente, omita el elemento para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es UNLINKED.
      Returns:
      anchorType
      Default:
      UNLINKED

    • sequence

      int sequence
      sequence específica el número de secuencia o posición relativa en la que se muestra el parámetro en las vistas (páginas) de ejecución de operaciones de negocio. Su valor debe ser un número entero entre 0 y 2.147.483.647. Alternativamente, omita el elemento para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es 0. Si todas los parámetros tienen el mismo número de secuencia (0 o cualquier otro), entonces las vistas las muestran en el mismo orden en el que las meta parámetros están definidos en la meta operación.
      Returns:
      sequence
      Default:
      0

    • inlineHelp

      InlineHelpType inlineHelp
      inlineHelp especifica el atributo del parámetro 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 del parámetro, establecida con el método setDefaultShortDescription o con el método setLocalizedShortDescription. Seleccione DESCRIPTION para utilizar la descripción corta del parámetro, si ésta fue establecida; o, de lo contrario, la descripción del parámetro, establecida con el método setDefaultDescription o con el método setLocalizedDescription. Seleccione NONE si desea que el parámetro 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