Package org.camunda.bpm.engine.impl.persistence.entity

Class JobDefinitionEntity

java.lang.Object
org.camunda.bpm.engine.impl.persistence.entity.JobDefinitionEntity
All Implemented Interfaces:
Serializable, DbEntity, HasDbReferences, HasDbRevision, JobDefinition
public class JobDefinitionEntity extends Object implements JobDefinition, HasDbRevision, HasDbReferences, DbEntity, Serializable
Author:
Daniel Meyer
See Also:

  • Field Details

    • id

      protected String id

    • revision

      protected int revision

    • processDefinitionId

      protected String processDefinitionId

    • processDefinitionKey

      protected String processDefinitionKey

    • activityId

      protected String activityId

    • jobType

      protected String jobType
      timer, message, ...

    • jobConfiguration

      protected String jobConfiguration

    • suspensionState

      protected int suspensionState

    • jobPriority

      protected Long jobPriority

    • tenantId

      protected String tenantId

    • deploymentId

      protected String deploymentId

  • Constructor Details

    • JobDefinitionEntity

      public JobDefinitionEntity()

    • JobDefinitionEntity

      public JobDefinitionEntity(JobDeclaration<?,?> jobDeclaration)

  • Method Details

    • getPersistentState

      public Object getPersistentState()
      Description copied from interface: DbEntity
      Returns a representation of the object, as would be stored in the database. Used when deciding if updates have occurred to the object or not since it was last loaded.
      Specified by:
      getPersistentState in interface DbEntity

    • getRevisionNext

      public int getRevisionNext()
      Specified by:
      getRevisionNext in interface HasDbRevision

    • getId

      public String getId()
      Specified by:
      getId in interface DbEntity
      Specified by:
      getId in interface JobDefinition
      Returns:
      the Id of the job definition.

    • setId

      public void setId(String id)
      Specified by:
      setId in interface DbEntity

    • getRevision

      public int getRevision()
      Specified by:
      getRevision in interface HasDbRevision

    • setRevision

      public void setRevision(int revision)
      Specified by:
      setRevision in interface HasDbRevision

    • isSuspended

      public boolean isSuspended()
      Description copied from interface: JobDefinition
      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.
      Specified by:
      isSuspended in interface JobDefinition
      Returns:
      true if this Job Definition is currently suspended.

    • getProcessDefinitionId

      public String getProcessDefinitionId()
      Specified by:
      getProcessDefinitionId in interface JobDefinition
      Returns:
      the id of the ProcessDefinition this job definition is associated with.

    • setProcessDefinitionId

      public void setProcessDefinitionId(String processDefinitionId)

    • getActivityId

      public String getActivityId()
      Description copied from interface: JobDefinition
      The Id of the activity (from BPMN 2.0 Xml) this Job Definition is associated with.
      Specified by:
      getActivityId in interface JobDefinition
      Returns:
      the activity id for this Job Definition.

    • setActivityId

      public void setActivityId(String activityId)

    • getJobType

      public String getJobType()
      Description copied from interface: JobDefinition
      The Type of a job. Asynchronous continuation, timer, ...
      Specified by:
      getJobType in interface JobDefinition
      Returns:
      the type of a Job.

    • setJobType

      public void setJobType(String jobType)

    • getJobConfiguration

      public String getJobConfiguration()
      Description copied from interface: JobDefinition
      The configuration of a job definition provides details about the jobs which will be created. For timer jobs this method returns the timer configuration.
      Specified by:
      getJobConfiguration in interface JobDefinition
      Returns:
      the configuration of this job definition.

    • setJobConfiguration

      public void setJobConfiguration(String jobConfiguration)

    • getProcessDefinitionKey

      public String getProcessDefinitionKey()
      Specified by:
      getProcessDefinitionKey in interface JobDefinition
      Returns:
      the key of the ProcessDefinition this job definition is associated with.

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(String processDefinitionKey)

    • getSuspensionState

      public int getSuspensionState()

    • setSuspensionState

      public void setSuspensionState(int state)

    • getOverridingJobPriority

      public Long getOverridingJobPriority()
      Description copied from interface: JobDefinition

      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.

      Specified by:
      getOverridingJobPriority in interface JobDefinition
      Returns:
      the priority that overrides the default/BPMN XML priority or null if no overriding priority is set

    • setJobPriority

      public void setJobPriority(Long jobPriority)

    • getTenantId

      public String getTenantId()
      Description copied from interface: JobDefinition
      The id of the tenant this job definition belongs to. Can be null if the definition belongs to no single tenant.
      Specified by:
      getTenantId in interface JobDefinition

    • setTenantId

      public void setTenantId(String tenantId)

    • getDeploymentId

      public String getDeploymentId()
      Description copied from interface: JobDefinition
      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.
      Specified by:
      getDeploymentId in interface JobDefinition

    • setDeploymentId

      public void setDeploymentId(String deploymentId)

    • getReferencedEntityIds

      public Set<String> getReferencedEntityIds()
      Description copied from interface: HasDbReferences

      Scope: IN-MEMORY references

      Specified by:
      getReferencedEntityIds in interface HasDbReferences
      Returns:
      the ids of the entities that this entity references. Should only return ids for entities of the same type

    • getReferencedEntitiesIdAndClass

      public Map<String,Class> getReferencedEntitiesIdAndClass()
      Description copied from interface: HasDbReferences

      Scope: IN-MEMORY references

      Specified by:
      getReferencedEntitiesIdAndClass in interface HasDbReferences
      Returns:
      a map of the ids and the entities' classes that this entity references. It's used when trying to determine if there was an Optimistic Locking occurrence on an INSERT or UPDATE of an object of this type.