Package org.activiti.engine.runtime
Interface Job
- All Known Subinterfaces:
AbstractJobEntity,DeadLetterJobEntity,JobEntity,SuspendedJobEntity,TimerJobEntity
- All Known Implementing Classes:
AbstractJobEntityImpl,DeadLetterJobEntityImpl,JobEntityImpl,SuspendedJobEntityImpl,TimerJobEntityImpl
Represents one job (timer, async job, etc.).
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionReturns the date on which this job is supposed to be processed.Returns the message of the exception that occurred, the last time the job was executed.Returns the specific execution on which the job was created.getId()Returns the unique identifier for this job.Get the job configuration.Get the job handler type.Get the job type for this job.Returns the specific process definition on which the job was createdReturns the id of the process instance which execution created the job.intReturns the number of retries this job has left.Get the tenant identifier for this job.booleanIs the job exclusive?
-
Field Details
-
JOB_TYPE_TIMER
- See Also:
-
JOB_TYPE_MESSAGE
- See Also:
-
DEFAULT_EXCLUSIVE
static final boolean DEFAULT_EXCLUSIVE- See Also:
-
MAX_EXCEPTION_MESSAGE_LENGTH
static final int MAX_EXCEPTION_MESSAGE_LENGTH- See Also:
-
-
Method Details
-
getId
String getId()Returns the unique identifier for this job. -
getDuedate
Date getDuedate()Returns the date on which this job is supposed to be processed. -
getProcessInstanceId
String getProcessInstanceId()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 -
getRetries
int getRetries()Returns the number of retries this job has left. Whenever the jobexecutor fails to execute the job, this value is decremented. When it hits zero, the job is supposed to be dead and not retried again (ie a manual retry is required then). -
getExceptionMessage
String getExceptionMessage()Returns the message of the exception that occurred, the last time the job was executed. Returns null when no exception occurred. To get the full exception stacktrace, useManagementService.getJobExceptionStacktrace(String) -
getTenantId
String getTenantId()Get the tenant identifier for this job. -
isExclusive
boolean isExclusive()Is the job exclusive? -
getJobType
String getJobType()Get the job type for this job. -
getJobHandlerType
String getJobHandlerType()Get the job handler type. -
getJobHandlerConfiguration
String getJobHandlerConfiguration()Get the job configuration.
-