Package adalid.core.annotations

Annotation Interface OperationClass

@Retention(RUNTIME) @Target(TYPE) public @interface OperationClass
La anotación OperationClass se utiliza para establecer atributos básicos de la operación. Es válida para cualquier clase de operación de negocio.
Author:
Jorge Campins

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    OperationAccess
    access
    access especifica el tipo de control de acceso de la operación.
    Kleenean
    asynchronous
    asynchronous indica si la operación se debe ejecutar de manera síncrona o asíncrona.
    Kleenean
    complex
    complex indica si la operación es, o no, una operación compleja.
    Kleenean
    confirmation
    confirmation indica si las vistas (páginas) de procesamiento deben solicitar, o no, confirmación al ejecutar la operación.
    int
    dialogSize
    dialogSize especifica el porcentaje del espacio disponible en la ventana actual que ocupa la ventana emergente para ejecutar la operación, cuando se abre la consola de procesamiento como un diálogo.
    OperationLogging
    logging
    logging especifica cuando se deben registrar pistas de auditoría de la ejecución de la operación.
    Kleenean
    shell
    shell indica si la operación se debe ejecutar utilizando un proceso nativo del sistema operativo, cuando el uso de procesos nativos esté permitido para la clase de operación (vea los métodos setExporterShellEnabled, setReporterShellEnabled y setSqlAgentShellEnabled).

  • Element Details

    • confirmation

      Kleenean confirmation
      confirmation indica si las vistas (páginas) de procesamiento deben solicitar, o no, confirmación al ejecutar la operación. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para solicitar confirmación; 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 el establecido con el método setBusinessOperationConfirmationRequired del proyecto maestro.
      Returns:
      confirmation
      Default:
      UNSPECIFIED

    • access

      OperationAccess access
      access especifica el tipo de control de acceso de la operación. Su valor es uno de los elementos de la enumeración OperationAccess. Seleccione PRIVATE, PUBLIC, PROTECTED o RESTRICTED si la operación es de acceso privado, público, protegido o restringido, respectivamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es RESTRICTED. Las operaciones con acceso privado no pueden ser ejecutadas directamente por los usuarios del sistema. Son ejecutadas solo por otras operaciones, a través de la Interfaz de Programación (API). Las operaciones con acceso público, protegido y restringido si pueden ser ejecutadas directamente por los usuarios del sistema, a través de la Interfaz de Usuario (UI). Las operaciones con acceso público pueden ser ejecutadas por todos los usuarios del sistema, aun cuando no tengan autorización explícita para ello. Las operaciones con acceso protegido pueden ser ejecutadas por usuarios designados como súper-usuario o por usuarios explícitamente autorizados. Al igual que las operaciones con acceso protegido, las operaciones con acceso restringido pueden ser ejecutadas por usuarios designados como súper-usuario o por usuarios explícitamente autorizados. Además, a diferencia de las operaciones con acceso protegido, las operaciones personalizables con acceso restringido, también pueden ser ejecutadas por usuarios que no tengan autorización explícita, pero solo sobre las instancias de la entidad que sean propiedad del usuario.
      Returns:
      access
      Default:
      RESTRICTED

    • asynchronous

      Kleenean asynchronous
      asynchronous indica si la operación se debe ejecutar de manera síncrona o asíncrona. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si se debe ejecutar de manera asíncrona; 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 para operaciones de clase y FALSE para operaciones de instancia.

      Este elemento no es relevante si la operación es un proceso de exportación (extensión de ExportOperation), un informe (extensión de ReportOperation), o un procedimiento almacenado en la base de datos (extensión de ProcedureOperation) de tipo VOID, ya que tales operaciones siempre se deben ejecutar de manera asíncrona.

      Returns:
      asynchronous
      Default:
      UNSPECIFIED

    • shell

      Kleenean shell
      shell indica si la operación se debe ejecutar utilizando un proceso nativo del sistema operativo, cuando el uso de procesos nativos esté permitido para la clase de operación (vea los métodos setExporterShellEnabled, setReporterShellEnabled y setSqlAgentShellEnabled). Solo aplica si la operación es un proceso de exportación (extensión de ExportOperation), un informe (extensión de ReportOperation), u otra clase de operación de negocio (extensión de ProcessOperation o ProcedureOperation) que esté implementada mediante una función o procedimiento almacenado en la base de datos y que se ejecute asincrónicamente. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE para utilizar un proceso nativo; seleccione FALSE para utilizar un subproceso del servidor de aplicaciones. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es TRUE, si la operación es un proceso de exportación, un informe o un procedimiento almacenado en la base de datos de tipo VOID; en los demás casos, FALSE.

      Este elemento no es relevante si la operación es un procedimiento almacenado en la base de datos de tipo VOID, ya que tales operaciones siempre se deben ejecutar utilizando un proceso nativo.

      Returns:
      shell
      Default:
      UNSPECIFIED

    • complex

      Kleenean complex
      complex indica si la operación es, o no, una operación compleja. Su valor es uno de los elementos de la enumeración Kleenean. Seleccione TRUE si la operación es compleja; 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:
      complex
      Default:
      UNSPECIFIED

    • dialogSize

      int dialogSize
      dialogSize especifica el porcentaje del espacio disponible en la ventana actual que ocupa la ventana emergente para ejecutar la operación, cuando se abre la consola de procesamiento como un diálogo. Por lo general, cuando el porcentaje es menor que 50, la ventana emergente será del tamaño mínimo requerido, el cual es 640 x 480 pixeles. Especifique 0 para no abrir la consola de procesamiento como un diálogo. El valor predeterminado es 0 si la operación es un constructor; de lo contrario, 100.
      Returns:
      dialogSize
      Default:
      -1

    • logging

      OperationLogging logging
      logging especifica cuando se deben registrar pistas de auditoría de la ejecución de la operación. Su valor es uno de los elementos de la enumeración OperationLogging. Seleccione SUCCESS, FAILURE o BOTH si las pistas se deben registrar cuando la operación se ejecute exitosamente, cuando se produzca un error al ejecutar la operación, o en ambos casos, respectivamente. Alternativamente, omita el elemento o seleccione UNSPECIFIED para utilizar el valor predeterminado del atributo. El valor predeterminado del atributo es SUCCESS.

      Este elemento no es relevante si el tipo de control de acceso de la operación es PRIVATE, ya que nunca se registran pistas de auditoría para tales operaciones.

      Returns:
      logging
      Default:
      UNSPECIFIED