ExternalTask (Camunda Platform Javadocs 7.15.19-ee)

All Known Implementing Classes:

ExternalTaskEntity
```
public interface ExternalTask
```
Represents an instance of an external task that is created when a service-task like activity (i.e. service task, send task, ...) with attribute camunda:type="external" is executed.

Author:

Thorben Lindhauer

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getActivityId()`
`String`	`getActivityInstanceId()`
`String`	`getBusinessKey()` Returns the business key of the process instance the external task belongs to
`String`	`getErrorMessage()`
`String`	`getExecutionId()`
`Map<String,String>`	`getExtensionProperties()` Returns a map containing all custom extension properties of the external task.
`String`	`getId()`
`Date`	`getLockExpirationTime()`
`long`	`getPriority()` Returns the priority of the external task.
`String`	`getProcessDefinitionId()`
`String`	`getProcessDefinitionKey()`
`String`	`getProcessDefinitionVersionTag()`
`String`	`getProcessInstanceId()`
`Integer`	`getRetries()`
`String`	`getTenantId()`
`String`	`getTopicName()`
`String`	`getWorkerId()`
`boolean`	`isSuspended()`

- Method Detail
  - getId
```
String getId()
```
    Returns:
    
    the id of the task
  - getTopicName
```
String getTopicName()
```
    Returns:
    
    the name of the topic the task belongs to
  - getWorkerId
```
String getWorkerId()
```
    Returns:
    
    the id of the worker that has locked the task
  - getLockExpirationTime
```
Date getLockExpirationTime()
```
    Returns:
    
    the absolute time at which the lock expires
  - getProcessInstanceId
```
String getProcessInstanceId()
```
    Returns:
    
    the id of the process instance the task exists in
  - getExecutionId
```
String getExecutionId()
```
    Returns:
    
    the id of the execution that the task is assigned to
  - getActivityId
```
String getActivityId()
```
    Returns:
    
    the id of the activity for which the task is created
  - getActivityInstanceId
```
String getActivityInstanceId()
```
    Returns:
    
    the id of the activity instance in which context the task exists
  - getProcessDefinitionId
```
String getProcessDefinitionId()
```
    Returns:
    
    the id of the process definition the tasks activity belongs to
  - getProcessDefinitionKey
```
String getProcessDefinitionKey()
```
    Returns:
    
    the key of the process definition the tasks activity belongs to
  - getProcessDefinitionVersionTag
```
String getProcessDefinitionVersionTag()
```
    Returns:
    
    the version tag of the process definition the tasks activity belongs to
  - getRetries
```
Integer getRetries()
```
    Returns:
    
    the number of retries left. The number of retries is provided by a task client, therefore the initial value is null.
  - getErrorMessage
```
String getErrorMessage()
```
    Returns:
    
    short error message submitted with the latest reported failure executing this task; null if no failure was reported previously or if no error message was submitted
    
    See Also:
    
    To get the full error details, use {@link ExternalTaskService#getExternalTaskErrorDetails(String)}
  - isSuspended
```
boolean isSuspended()
```
    Returns:
    
    true if the external task is suspended; a suspended external task cannot be completed, thereby preventing process continuation
  - getTenantId
```
String getTenantId()
```
    Returns:
    
    the id of the tenant the task belongs to. Can be null if the task belongs to no single tenant.
  - getPriority
```
long getPriority()
```
    Returns the priority of the external task.
    
    Returns:
    
    the priority of the external task
  - getExtensionProperties
```
Map<String,String> getExtensionProperties()
```
    Returns a map containing all custom extension properties of the external task.
    
    Returns:
    
    the properties, never null
  - getBusinessKey
```
String getBusinessKey()
```
    Returns the business key of the process instance the external task belongs to
    
    Returns:
    
    the business key

Interface ExternalTask

Method Summary

Method Detail

getId

getTopicName

getWorkerId

getLockExpirationTime

getProcessInstanceId

getExecutionId

getActivityId

getActivityInstanceId

getProcessDefinitionId

getProcessDefinitionKey

getProcessDefinitionVersionTag

getRetries

getErrorMessage

isSuspended

getTenantId

getPriority

getExtensionProperties

getBusinessKey