Package org.camunda.bpm.engine.management

Interface JobDefinition

All Known Implementing Classes:
JobDefinitionEntity
public interface JobDefinition

A Job Definition provides details about asynchronous background processing ("Jobs") performed by the process engine.

Each Job Definition corresponds to a Timer or Asynchronous continuation job installed in the process engine. Jobs definitions are installed when BPMN 2.0 processes containing timer activities or asynchronous continuations are deployed.

Author:
Daniel Meyer

  • Method Details

    • getId

      String getId()
      Returns:
      the Id of the job definition.

    • getProcessDefinitionId

      String getProcessDefinitionId()
      Returns:
      the id of the ProcessDefinition this job definition is associated with.

    • getProcessDefinitionKey

      String getProcessDefinitionKey()
      Returns:
      the key of the ProcessDefinition this job definition is associated with.

    • getJobType

      String getJobType()
      The Type of a job. Asynchronous continuation, timer, ...
      Returns:
      the type of a Job.

    • getJobConfiguration

      String getJobConfiguration()
      The configuration of a job definition provides details about the jobs which will be created. For timer jobs this method returns the timer configuration.
      Returns:
      the configuration of this job definition.

    • getActivityId

      String getActivityId()
      The Id of the activity (from BPMN 2.0 Xml) this Job Definition is associated with.
      Returns:
      the activity id for this Job Definition.

    • isSuspended

      boolean isSuspended()
      Indicates whether this job definition is suspended. If a job Definition is suspended, No Jobs created form the job definition will be acquired by the job executor.
      Returns:
      true if this Job Definition is currently suspended.

    • getOverridingJobPriority

      Long getOverridingJobPriority()

      Returns the execution priority for jobs of this definition, if it was set using the ManagementService API. When a job is assigned a priority, the job definition's overriding priority (if set) is used instead of the values defined in the BPMN XML.

      Returns:
      the priority that overrides the default/BPMN XML priority or null if no overriding priority is set
      Since:
      7.4

    • getTenantId

      String getTenantId()
      The id of the tenant this job definition belongs to. Can be null if the definition belongs to no single tenant.

    • getDeploymentId

      String getDeploymentId()
      The id of the deployment this job definition is related to. In a deployment-aware setup, this leads to all jobs of the same definition being executed on the same node.