Package org.flowable.job.api
Interface Job
- All Superinterfaces:
JobInfo
- All Known Subinterfaces:
AcquiredExternalWorkerJob
,ExternalWorkerJob
Represents one job (timer, async job, etc.).
- Author:
- Joram Barrez
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
static final String
static final String
static final String
Fields inherited from interface org.flowable.job.api.JobInfo
MAX_EXCEPTION_MESSAGE_LENGTH
-
Method Summary
Modifier and TypeMethodDescriptionGet the category for this job.Returns the correlation id of a job.Returns the create datetime of the job.Returns the date on which this job is supposed to be processed.Reference to an element identifier or null if none is set.Reference to an element name or null if none is set.Returns the specific execution on which the job was created.Get the job type for this job.Returns the specific process definition on which the job was createdx Returns the id of the process instance which execution created the job.Reference to a scope definition identifier or null if none is set.Reference to a scope identifier or null if none is set.Reference to a scope type or null if none is set.Reference to a sub scope identifier or null if none is set.boolean
Is the job exclusive?Methods inherited from interface org.flowable.job.api.JobInfo
getCustomValues, getExceptionMessage, getId, getJobHandlerConfiguration, getJobHandlerType, getRetries, getTenantId
-
Field Details
-
JOB_TYPE_TIMER
- See Also:
-
JOB_TYPE_MESSAGE
- See Also:
-
JOB_TYPE_EXTERNAL_WORKER
- See Also:
-
DEFAULT_EXCLUSIVE
static final boolean DEFAULT_EXCLUSIVE- See Also:
-
-
Method Details
-
getCorrelationId
String getCorrelationId()Returns the correlation id of a job. The same job can be moved around and have its technical id changed. This id allows tracking that job. -
getDuedate
Date getDuedate()Returns the date on which this job is supposed to be processed. -
getProcessInstanceId
String getProcessInstanceId()x Returns the id of the process instance which execution created the job. -
getExecutionId
String getExecutionId()Returns the specific execution on which the job was created. -
getProcessDefinitionId
String getProcessDefinitionId()Returns the specific process definition on which the job was created -
getCategory
String getCategory()Get the category for this job. -
getJobType
String getJobType()Get the job type for this job. -
getElementId
String getElementId()Reference to an element identifier or null if none is set. -
getElementName
String getElementName()Reference to an element name or null if none is set. -
getScopeId
String getScopeId()Reference to a scope identifier or null if none is set. -
getSubScopeId
String getSubScopeId()Reference to a sub scope identifier or null if none is set. -
getScopeType
String getScopeType()Reference to a scope type or null if none is set. -
getScopeDefinitionId
String getScopeDefinitionId()Reference to a scope definition identifier or null if none is set. -
isExclusive
boolean isExclusive()Is the job exclusive? -
getCreateTime
Date getCreateTime()Returns the create datetime of the job.
-