Package org.activiti.engine.runtime
Interface Job
-
- All Known Subinterfaces:
AbstractJobEntity,DeadLetterJobEntity,JobEntity,SuspendedJobEntity,TimerJobEntity
- All Known Implementing Classes:
AbstractJobEntityImpl,DeadLetterJobEntityImpl,JobEntityImpl,SuspendedJobEntityImpl,TimerJobEntityImpl
@Internal public interface Job
Represents one job (timer, async job, etc.).
-
-
Field Summary
Fields Modifier and Type Field Description static booleanDEFAULT_EXCLUSIVEstatic java.lang.StringJOB_TYPE_MESSAGEstatic java.lang.StringJOB_TYPE_TIMERstatic intMAX_EXCEPTION_MESSAGE_LENGTH
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.DategetDuedate()Returns the date on which this job is supposed to be processed.java.lang.StringgetExceptionMessage()Returns the message of the exception that occurred, the last time the job was executed.java.lang.StringgetExecutionId()Returns the specific execution on which the job was created.java.lang.StringgetId()Returns the unique identifier for this job.java.lang.StringgetJobHandlerConfiguration()Get the job configuration.java.lang.StringgetJobHandlerType()Get the job handler type.java.lang.StringgetJobType()Get the job type for this job.java.lang.StringgetProcessDefinitionId()Returns the specific process definition on which the job was createdjava.lang.StringgetProcessInstanceId()Returns the id of the process instance which execution created the job.intgetRetries()Returns the number of retries this job has left.java.lang.StringgetTenantId()Get the tenant identifier for this job.booleanisExclusive()Is the job exclusive?
-
-
-
Field Detail
-
JOB_TYPE_TIMER
static final java.lang.String JOB_TYPE_TIMER
- See Also:
- Constant Field Values
-
JOB_TYPE_MESSAGE
static final java.lang.String JOB_TYPE_MESSAGE
- See Also:
- Constant Field Values
-
DEFAULT_EXCLUSIVE
static final boolean DEFAULT_EXCLUSIVE
- See Also:
- Constant Field Values
-
MAX_EXCEPTION_MESSAGE_LENGTH
static final int MAX_EXCEPTION_MESSAGE_LENGTH
- See Also:
- Constant Field Values
-
-
Method Detail
-
getId
java.lang.String getId()
Returns the unique identifier for this job.
-
getDuedate
java.util.Date getDuedate()
Returns the date on which this job is supposed to be processed.
-
getProcessInstanceId
java.lang.String getProcessInstanceId()
Returns the id of the process instance which execution created the job.
-
getExecutionId
java.lang.String getExecutionId()
Returns the specific execution on which the job was created.
-
getProcessDefinitionId
java.lang.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
java.lang.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
java.lang.String getTenantId()
Get the tenant identifier for this job.
-
isExclusive
boolean isExclusive()
Is the job exclusive?
-
getJobType
java.lang.String getJobType()
Get the job type for this job.
-
getJobHandlerType
java.lang.String getJobHandlerType()
Get the job handler type.
-
getJobHandlerConfiguration
java.lang.String getJobHandlerConfiguration()
Get the job configuration.
-
-