Package com.veeva.vault.sdk.api.job

Annotation Interface JobInfo

@Target(TYPE) @Retention(RUNTIME) public @interface JobInfo
Annotates a class that implements Job, Indicating a class is a job processor. Describes the job and defines job behavior and visibility.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    adminCancellable
    Determines if this job processor permits the cancellation of job instances.
    boolean
    adminConfigurable
    Determines if this job processor is available for Vault Admins to configure as a Job Definition in the Vault UI, and if custom SDK code can invoke this job processor.
    boolean
    idempotent
    Indicates if the job is idempotent: If the job will produce the same outcome if it is run multiple times.
    boolean
    isVisible
    Determines if a job will appear in the Scheduled, Running, and History tables in the Job Admin UI.

  • Element Details

    • idempotent

      boolean idempotent
      Indicates if the job is idempotent: If the job will produce the same outcome if it is run multiple times.

      For example, deleting a record is idempotent. Creating a record is not idempotent. An idempotent job can be automatically restarted in the event of a system failure.

      Defaults to false, which means the job is not idempotent.

      Returns:
      true if the job is idempotent, otherwise false
      Default:
      false

    • adminConfigurable

      boolean adminConfigurable
      Determines if this job processor is available for Vault Admins to configure as a Job Definition in the Vault UI, and if custom SDK code can invoke this job processor.
      • False: Default value: This job processor does not appear in the list of job types when creating a job in the Admin UI. This job processor cannot be invoked by custom SDK code.
      • True: This job processor appears in the list of job types when creating a job in the Vault Admin UI. If an Admin selects this job Type, they can create a job definition and set the schedule. This job processor can be invoked by custom SDK code.
      Returns:
      true if the job appears in Vault Admin for configuration and is available to be called by custom code, otherwise false
      Default:
      false

    • adminCancellable

      boolean adminCancellable
      Determines if this job processor permits the cancellation of job instances.
      • False: Default value: This job processor does not allow the cancellation of job instances.
      • True: This job processor allows the cancellation of job instances.
      Returns:
      true if cancellation is allowed, otherwise false
      Default:
      false

    • isVisible

      boolean isVisible
      Determines if a job will appear in the Scheduled, Running, and History tables in the Job Admin UI.

      Defaults to true, which means the job will appear in the Job Admin UI by default.

      Returns:
      true if the job is visible in the Admin UI, otherwise false
      Default:
      true