org.activiti.engine.runtime

Interface Job

public interface Job

Represents one job (timer, async job, etc.).

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_EXCLUSIVE
static String	JOB_TYPE_MESSAGE
static String	JOB_TYPE_TIMER
static int	MAX_EXCEPTION_MESSAGE_LENGTH

Method Summary

Methods

Modifier and Type	Method and Description
Date	getDuedate() Returns the date on which this job is supposed to be processed.
String	getExceptionMessage() Returns the message of the exception that occurred, the last time the job was executed.
String	getExecutionId() Returns the specific execution on which the job was created.
String	getId() Returns the unique identifier for this job.
String	getJobHandlerConfiguration() Get the job configuration.
String	getJobHandlerType() Get the job handler type.
String	getJobType() Get the job type for this job.
String	getProcessDefinitionId() Returns the specific process definition on which the job was created
String	getProcessInstanceId() Returns the id of the process instance which execution created the job.
int	getRetries() Returns the number of retries this job has left.
String	getTenantId() Get the tenant identifier for this job.
boolean	isExclusive() Is the job exclusive?

Field Detail

JOB_TYPE_TIMER

static final String JOB_TYPE_TIMER

See Also:

Constant Field Values

JOB_TYPE_MESSAGE

static final 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

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, use ManagementService.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.