Package org.camunda.bpm.engine.history
Interface HistoricExternalTaskLog
-
- All Known Implementing Classes:
HistoricExternalTaskLogEntity
public interface HistoricExternalTaskLog
The
An instance ofHistoricExternalTaskLog
is used to have a log containing information abouttask
execution. The log provides details about the last lifecycle state of atask
:HistoricExternalTaskLog
represents the latest historic state in the lifecycle of atask
.- Since:
- 7.7
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getActivityId()
Returns the id of the activity which the external task associated with.java.lang.String
getActivityInstanceId()
Returns the id of the activity instance on which the associated external task was created.java.lang.String
getErrorMessage()
Returns the message of the error that occurred by executing the associated external task.java.lang.String
getExecutionId()
Returns the specific execution id on which the associated external task was created.java.lang.String
getExternalTaskId()
Returns the id of the associated external task.java.lang.String
getId()
Returns the unique identifier forthis
historic external task log.long
getPriority()
Returns the priority of the associated external task whenthis
log entry was created.java.lang.String
getProcessDefinitionId()
Returns the specific process definition id on which the associated external task was created.java.lang.String
getProcessDefinitionKey()
Returns the specific process definition key on which the associated external task was created.java.lang.String
getProcessInstanceId()
Returns the specific process instance id on which the associated external task was created.java.util.Date
getRemovalTime()
The time the historic external task log will be removed.java.lang.Integer
getRetries()
Returns the retries of the associated external task before the associated external task has been executed and whenthis
log occurred.java.lang.String
getRootProcessInstanceId()
Returns the specific root process instance id of the process instance on which the associated external task was created.java.lang.String
getTenantId()
Returns the id of the tenant this external task log entry belongs to.java.util.Date
getTimestamp()
Returns the time whenthis
log occurred.java.lang.String
getTopicName()
Returns the topic name of the associated external task.java.lang.String
getWorkerId()
Returns the id of the worker that fetched the external task most recently.boolean
isCreationLog()
Returnstrue
whenthis
log represents the creation of the associated external task.boolean
isDeletionLog()
Returnstrue
whenthis
log represents the deletion of the associated external task.boolean
isFailureLog()
Returnstrue
whenthis
log represents the failed execution of the associated external task.boolean
isSuccessLog()
Returnstrue
whenthis
log represents the successful execution of the associated external task.
-
-
-
Method Detail
-
getId
java.lang.String getId()
Returns the unique identifier forthis
historic external task log.
-
getTimestamp
java.util.Date getTimestamp()
Returns the time whenthis
log occurred.
-
getExternalTaskId
java.lang.String getExternalTaskId()
Returns the id of the associated external task.
-
getRetries
java.lang.Integer getRetries()
Returns the retries of the associated external task before the associated external task has been executed and whenthis
log occurred.
-
getPriority
long getPriority()
Returns the priority of the associated external task whenthis
log entry was created.
-
getTopicName
java.lang.String getTopicName()
Returns the topic name of the associated external task.
-
getWorkerId
java.lang.String getWorkerId()
Returns the id of the worker that fetched the external task most recently.
-
getErrorMessage
java.lang.String getErrorMessage()
Returns the message of the error that occurred by executing the associated external task. To get the full error details, useHistoryService.getHistoricExternalTaskLogErrorDetails(String)
-
getActivityId
java.lang.String getActivityId()
Returns the id of the activity which the external task associated with.
-
getActivityInstanceId
java.lang.String getActivityInstanceId()
Returns the id of the activity instance on which the associated external task was created.
-
getExecutionId
java.lang.String getExecutionId()
Returns the specific execution id on which the associated external task was created.
-
getRootProcessInstanceId
java.lang.String getRootProcessInstanceId()
Returns the specific root process instance id of the process instance on which the associated external task was created.
-
getProcessInstanceId
java.lang.String getProcessInstanceId()
Returns the specific process instance id on which the associated external task was created.
-
getProcessDefinitionId
java.lang.String getProcessDefinitionId()
Returns the specific process definition id on which the associated external task was created.
-
getProcessDefinitionKey
java.lang.String getProcessDefinitionKey()
Returns the specific process definition key on which the associated external task was created.
-
getTenantId
java.lang.String getTenantId()
Returns the id of the tenant this external task log entry belongs to. Can benull
if the external task log entry belongs to no single tenant.
-
isCreationLog
boolean isCreationLog()
Returnstrue
whenthis
log represents the creation of the associated external task.
-
isFailureLog
boolean isFailureLog()
Returnstrue
whenthis
log represents the failed execution of the associated external task.
-
isSuccessLog
boolean isSuccessLog()
Returnstrue
whenthis
log represents the successful execution of the associated external task.
-
isDeletionLog
boolean isDeletionLog()
Returnstrue
whenthis
log represents the deletion of the associated external task.
-
getRemovalTime
java.util.Date getRemovalTime()
The time the historic external task log will be removed.
-
-