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 Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe Id of the activity (from BPMN 2.0 Xml) this Job Definition is associated with.The id of the deployment this job definition is related to.getId()
The configuration of a job definition provides details about the jobs which will be created.The Type of a job.Returns the execution priority for jobs of this definition, if it was set using theManagementService
API.Returns a representation of the object, as would be stored in the database.Scope: IN-MEMORY referencesScope: IN-MEMORY referencesint
int
int
The id of the tenant this job definition belongs to.boolean
Indicates whether this job definition is suspended.void
setActivityId
(String activityId) void
setDeploymentId
(String deploymentId) void
void
setJobConfiguration
(String jobConfiguration) void
setJobPriority
(Long jobPriority) void
setJobType
(String jobType) void
setProcessDefinitionId
(String processDefinitionId) void
setProcessDefinitionKey
(String processDefinitionKey) void
setRevision
(int revision) void
setSuspensionState
(int state) void
setTenantId
(String tenantId) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.camunda.bpm.engine.impl.db.HasDbReferences
getDependentEntities
-
Field Details
-
id
-
revision
protected int revision -
processDefinitionId
-
processDefinitionKey
-
activityId
-
jobType
timer, message, ... -
jobConfiguration
-
suspensionState
protected int suspensionState -
jobPriority
-
tenantId
-
deploymentId
-
-
Constructor Details
-
JobDefinitionEntity
public JobDefinitionEntity() -
JobDefinitionEntity
-
-
Method Details
-
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 interfaceDbEntity
-
getRevisionNext
public int getRevisionNext()- Specified by:
getRevisionNext
in interfaceHasDbRevision
-
getId
- Specified by:
getId
in interfaceDbEntity
- Specified by:
getId
in interfaceJobDefinition
- Returns:
- the Id of the job definition.
-
setId
-
getRevision
public int getRevision()- Specified by:
getRevision
in interfaceHasDbRevision
-
setRevision
public void setRevision(int revision) - Specified by:
setRevision
in interfaceHasDbRevision
-
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 interfaceJobDefinition
- Returns:
- true if this Job Definition is currently suspended.
-
getProcessDefinitionId
- Specified by:
getProcessDefinitionId
in interfaceJobDefinition
- Returns:
- the id of the
ProcessDefinition
this job definition is associated with.
-
setProcessDefinitionId
-
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 interfaceJobDefinition
- Returns:
- the activity id for this Job Definition.
-
setActivityId
-
getJobType
Description copied from interface:JobDefinition
The Type of a job. Asynchronous continuation, timer, ...- Specified by:
getJobType
in interfaceJobDefinition
- Returns:
- the type of a Job.
-
setJobType
-
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 interfaceJobDefinition
- Returns:
- the configuration of this job definition.
-
setJobConfiguration
-
getProcessDefinitionKey
- Specified by:
getProcessDefinitionKey
in interfaceJobDefinition
- Returns:
- the key of the
ProcessDefinition
this job definition is associated with.
-
setProcessDefinitionKey
-
getSuspensionState
public int getSuspensionState() -
setSuspensionState
public void setSuspensionState(int state) -
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 interfaceJobDefinition
- Returns:
- the priority that overrides the default/BPMN XML priority or
null
if no overriding priority is set
-
setJobPriority
-
getTenantId
Description copied from interface:JobDefinition
The id of the tenant this job definition belongs to. Can benull
if the definition belongs to no single tenant.- Specified by:
getTenantId
in interfaceJobDefinition
-
setTenantId
-
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 interfaceJobDefinition
-
setDeploymentId
-
getReferencedEntityIds
Description copied from interface:HasDbReferences
Scope: IN-MEMORY references
- Specified by:
getReferencedEntityIds
in interfaceHasDbReferences
- Returns:
- the ids of the entities that this entity references. Should only return ids for entities of the same type
-
getReferencedEntitiesIdAndClass
Description copied from interface:HasDbReferences
Scope: IN-MEMORY references
- Specified by:
getReferencedEntitiesIdAndClass
in interfaceHasDbReferences
- 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.
-