org.camunda.bpm.engine.history
Interface HistoricExternalTaskLog

All Known Implementing Classes:

HistoricExternalTaskLogEntity

public interface HistoricExternalTaskLog

The HistoricExternalTaskLog is used to have a log containing information about task execution. The log provides details about the last lifecycle state of a task:

An instance of HistoricExternalTaskLog represents the latest historic state in the lifecycle of a task.

Since:

7.7

Method Summary

String	getActivityId() Returns the id of the activity which the external task associated with.
String	getActivityInstanceId() Returns the id of the activity instance on which the associated external task was created.
String	getErrorMessage() Returns the message of the error that occurred by executing the associated external task.
String	getExecutionId() Returns the specific execution id on which the associated external task was created.
String	getExternalTaskId() Returns the id of the associated external task.
String	getId() Returns the unique identifier for this historic external task log.
long	getPriority() Returns the priority of the associated external task when this log entry was created.
String	getProcessDefinitionId() Returns the specific process definition id on which the associated external task was created.
String	getProcessDefinitionKey() Returns the specific process definition key on which the associated external task was created.
String	getProcessInstanceId() Returns the specific process instance id on which the associated external task was created.
Integer	getRetries() Returns the retries of the associated external task before the associated external task has been executed and when this log occurred.
String	getTenantId() Returns the id of the tenant this external task log entry belongs to.
Date	getTimestamp() Returns the time when this log occurred.
String	getTopicName() Returns the topic name of the associated external task.
String	getWorkerId() Returns the id of the worker that fetched the external task most recently.
boolean	isCreationLog() Returns true when this log represents the creation of the associated external task.
boolean	isDeletionLog() Returns true when this log represents the deletion of the associated external task.
boolean	isFailureLog() Returns true when this log represents the failed execution of the associated external task.
boolean	isSuccessLog() Returns true when this log represents the successful execution of the associated external task.

Method Detail

getId

String getId()

Returns the unique identifier for this historic external task log.

getTimestamp

Date getTimestamp()

Returns the time when this log occurred.

getExternalTaskId

String getExternalTaskId()

Returns the id of the associated external task.

getRetries

Integer getRetries()

Returns the retries of the associated external task before the associated external task has been executed and when this log occurred.

getPriority

long getPriority()

Returns the priority of the associated external task when this log entry was created.

getTopicName

String getTopicName()

Returns the topic name of the associated external task.

getWorkerId

String getWorkerId()

Returns the id of the worker that fetched the external task most recently.

getErrorMessage

String getErrorMessage()

Returns the message of the error that occurred by executing the associated external task. To get the full error details, use HistoryService.getHistoricExternalTaskLogErrorDetails(String)

getActivityId

String getActivityId()

Returns the id of the activity which the external task associated with.

getActivityInstanceId

String getActivityInstanceId()

Returns the id of the activity instance on which the associated external task was created.

getExecutionId

String getExecutionId()

Returns the specific execution id on which the associated external task was created.

getProcessInstanceId

String getProcessInstanceId()

Returns the specific process instance id on which the associated external task was created.

getProcessDefinitionId

String getProcessDefinitionId()

Returns the specific process definition id on which the associated external task was created.

getProcessDefinitionKey

String getProcessDefinitionKey()

Returns the specific process definition key on which the associated external task was created.

getTenantId

String getTenantId()

Returns the id of the tenant this external task log entry belongs to. Can be null if the external task log entry belongs to no single tenant.

isCreationLog

boolean isCreationLog()

Returns true when this log represents the creation of the associated external task.

isFailureLog

boolean isFailureLog()

Returns true when this log represents the failed execution of the associated external task.

isSuccessLog

boolean isSuccessLog()

Returns true when this log represents the successful execution of the associated external task.

isDeletionLog

boolean isDeletionLog()

Returns true when this log represents the deletion of the associated external task.