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

Annotation Interface JobInfo

@Target(TYPE) @Retention(RUNTIME) public @interface JobInfo
Indicates a class is a job processor. Describes the job and defines job properties.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    adminConfigurable
    Determines if the job processor is available to be called with custom SDK code or by configuration by an Admin as a Job Definition in the Vault UI.
    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 the job processor is available to be called with custom SDK code or by configuration by an Admin as a Job Definition in the Vault UI. Defaults to false.
      • False: The job does not appear in the list of job types when creating a job in the Admin UI. It cannot be invoked by custom SDK code.
      • True: The job appears in the list of job types when creating a job in the Admin UI. If an Admin selects this job Type, they can create a job definition and set the schedule.
      Returns:
      true if the job appears in Vault Admin for configuration and is available to be called by custom code, 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.

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