Package adalid.core.annotations

Annotation Interface ExportOperationClass

@Retention(RUNTIME) @Target(TYPE) public @interface ExportOperationClass
La anotación ExportOperationClass se utiliza para establecer atributos de meta operaciones que extienden la clase ExportOperation (operaciones de negocio para generar archivos).
Author:
Jorge Campins

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    chartRowsLimit
    chartRowsLimit específica el número de máximo de filas que se deben exportar al generar archivos gráficos.
    int
    detailRowsLimit
    detailRowsLimit específica el número de máximo de filas que se deben exportar al generar archivos detallados.
    ExportFileType[]
    fileTypes
    fileTypes especifica uno o más tipos de archivo que puede generar la operación.
    String
    name
    name especifica el nombre alterno del procedimiento de generación del archivo.
    int
    rowsLimit
    rowsLimit específica el número de máximo de filas que se deben exportar.
    SortOption
    sortOption
    sortOption especifica el criterio de ordenamiento por omisión de las filas exportadas.
    int
    summaryRowsLimit
    summaryRowsLimit específica el número de máximo de filas que se deben exportar al generar archivos resumidos.
    ExportQueryType
    type
    type especifica el tipo de consulta de la operación.
    String
    view
    view especifica el nombre de la vista SQL que se utiliza para la generación del archivo.
    String
    viewField
    viewField especifica el nombre de la vista de la entidad que se utiliza para la generación del archivo.

  • Element Details

    • name

      String name
      name especifica el nombre alterno del procedimiento de generación del archivo.
      Returns:
      name
      Default:
      ""

    • view

      String view
      view especifica el nombre de la vista SQL que se utiliza para la generación del archivo.
      Returns:
      view
      Default:
      ""

    • viewField

      String viewField
      viewField especifica el nombre de la vista de la entidad que se utiliza para la generación del archivo. Si alguna de las propiedades de detalle de la vista tiene una función de agregación, entonces la operación puede generar el archivo tanto detallado como resumido; en caso contrario, solo puede generar el archivo detallado.
      Returns:
      viewField
      Default:
      ""

    • type

      ExportQueryType type
      type especifica el tipo de consulta de la operación. Su valor es uno de los elementos de la enumeración ExportQueryType. Seleccione DYNAMIC o PARAMETERIZED si la consulta es dinámica o parametrizada, respectivamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es DYNAMIC. Las consultas dinámicas son aquellas que dinámicamente construyen la cláusula WHERE de la consulta a partir de los parámetros no nulos de la operación y de sus respectivos operadores escalares de comparación (vea Anotación ParameterField). Las consultas parametrizadas son consultas estáticas (su cláusula WHERE está prestablecida) que utilizan todos los parámetros (aun los nulos) de la operación.
      Returns:
      type
      Default:
      DYNAMIC

    • fileTypes

      ExportFileType[] fileTypes
      fileTypes especifica uno o más tipos de archivo que puede generar la operación. Su valor es una lista de elementos de la enumeración ExportFileType. Incluya CSV para generar archivos de valores separados por coma o punto y coma, dependiendo de la configuración regional. Incluya TSV para generar archivos de valores separados por tabulaciones. El valor predeterminado del atributo es solamente CSV.
      Returns:
      fileTypes
      Default:
      {CSV}

    • rowsLimit

      int rowsLimit
      rowsLimit específica el número de máximo de filas que se deben exportar. Su valor debe ser un número entero entre 0 y 1.000.000. Utilice 0 cuando no exista límite. El valor predeterminado es 10.000
      Returns:
      rowsLimit
      Default:
      10000

    • detailRowsLimit

      int detailRowsLimit
      detailRowsLimit específica el número de máximo de filas que se deben exportar al generar archivos detallados. Su valor debe ser un número entero entre 0 y 1.000.000. Utilice 0 cuando no exista límite. El valor predeterminado es 10.000
      Returns:
      detailRowsLimit
      Default:
      10000

    • summaryRowsLimit

      int summaryRowsLimit
      summaryRowsLimit específica el número de máximo de filas que se deben exportar al generar archivos resumidos. Su valor debe ser un número entero entre 0 y 1.000.000. Utilice 0 cuando no exista límite. El valor predeterminado es 10.000
      Returns:
      summaryRowsLimit
      Default:
      10000

    • chartRowsLimit

      int chartRowsLimit
      chartRowsLimit específica el número de máximo de filas que se deben exportar al generar archivos gráficos. Su valor debe ser un número entero entre 0 y 1.000.000. Utilice 0 cuando no exista límite. El valor predeterminado es 10.000
      Returns:
      chartRowsLimit
      Default:
      10000

    • sortOption

      SortOption sortOption
      sortOption especifica el criterio de ordenamiento por omisión de las filas exportadas. Su valor es uno de los elementos de la enumeración SortOption. Seleccione ASC o DESC para exportar las filas ordenadas por el valor de su clave primaria, de manera ascendente o descendente, respectivamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es ASC.
      Returns:
      sortOption
      Default:
      ASC