java.lang.Object
- org.camunda.bpm.engine.impl.externaltask.LockedExternalTaskImpl

All Implemented Interfaces:: LockedExternalTask

public class LockedExternalTaskImpl
extends Object
implements LockedExternalTask

Author:: Thorben Lindhauer

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`activityId`
`protected String`	`activityInstanceId`
`protected String`	`businessKey`
`protected String`	`errorDetails`
`protected String`	`errorMessage`
`protected String`	`executionId`
`protected Map<String,String>`	`extensionProperties`
`protected String`	`id`
`protected Date`	`lockExpirationTime`
`protected long`	`priority`
`protected String`	`processDefinitionId`
`protected String`	`processDefinitionKey`
`protected String`	`processDefinitionVersionTag`
`protected String`	`processInstanceId`
`protected Integer`	`retries`
`protected String`	`tenantId`
`protected String`	`topicName`
`protected VariableMapImpl`	`variables`
`protected String`	`workerId`

Constructor Summary

Constructors
Constructor Description

LockedExternalTaskImpl()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static LockedExternalTaskImpl`	`fromEntity(ExternalTaskEntity externalTaskEntity, List<String> variablesToFetch, boolean isLocal, boolean deserializeVariables, boolean includeExtensionProperties)`	Construct representation of locked ExternalTask from corresponding entity.
`String`	`getActivityId()`
`String`	`getActivityInstanceId()`
`String`	`getBusinessKey()`	Returns the business key of the process instance the external task belongs to
`String`	`getErrorDetails()`
`String`	`getErrorMessage()`
`String`	`getExecutionId()`
`Map<String,String>`	`getExtensionProperties()`	Returns a map of custom extension properties if the fetch instructions indicate to include extension properties.
`String`	`getId()`
`Date`	`getLockExpirationTime()`
`long`	`getPriority()`	Returns the priority of the locked external task.
`String`	`getProcessDefinitionId()`
`String`	`getProcessDefinitionKey()`
`String`	`getProcessDefinitionVersionTag()`
`String`	`getProcessInstanceId()`
`Integer`	`getRetries()`
`String`	`getTenantId()`
`String`	`getTopicName()`
`VariableMap`	`getVariables()`
`String`	`getWorkerId()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
protected String id
```
  - topicName
```
protected String topicName
```
  - workerId
```
protected String workerId
```
  - lockExpirationTime
```
protected Date lockExpirationTime
```
  - retries
```
protected Integer retries
```
  - errorMessage
```
protected String errorMessage
```
  - errorDetails
```
protected String errorDetails
```
  - processInstanceId
```
protected String processInstanceId
```
  - executionId
```
protected String executionId
```
  - activityId
```
protected String activityId
```
  - activityInstanceId
```
protected String activityInstanceId
```
  - processDefinitionId
```
protected String processDefinitionId
```
  - processDefinitionKey
```
protected String processDefinitionKey
```
  - processDefinitionVersionTag
```
protected String processDefinitionVersionTag
```
  - tenantId
```
protected String tenantId
```
  - priority
```
protected long priority
```
  - variables
```
protected VariableMapImpl variables
```
  - businessKey
```
protected String businessKey
```
  - extensionProperties
```
protected Map<String,String> extensionProperties
```
- Constructor Detail
  - LockedExternalTaskImpl
```
public LockedExternalTaskImpl()
```
- Method Detail
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface LockedExternalTask
    
    Returns:
    
    the id of the task
  - getTopicName
```
public String getTopicName()
```
    Specified by:
    
    getTopicName in interface LockedExternalTask
    
    Returns:
    
    the name of the topic the task belongs to
  - getWorkerId
```
public String getWorkerId()
```
    Specified by:
    
    getWorkerId in interface LockedExternalTask
    
    Returns:
    
    the id of the worker that has locked the task
  - getLockExpirationTime
```
public Date getLockExpirationTime()
```
    Specified by:
    
    getLockExpirationTime in interface LockedExternalTask
    
    Returns:
    
    the absolute time at which the lock expires
  - getRetries
```
public Integer getRetries()
```
    Specified by:
    
    getRetries in interface LockedExternalTask
    
    Returns:
    
    the number of retries left. The number of retries is provided by a task client, therefore the initial value is null.
  - getErrorMessage
```
public String getErrorMessage()
```
    Specified by:
    
    getErrorMessage in interface LockedExternalTask
    
    Returns:
    
    the full 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:
    
    ExternalTaskService.handleFailure(String, String, String, int, long)
  - getProcessInstanceId
```
public String getProcessInstanceId()
```
    Specified by:
    
    getProcessInstanceId in interface LockedExternalTask
    
    Returns:
    
    the id of the process instance the task exists in
  - getExecutionId
```
public String getExecutionId()
```
    Specified by:
    
    getExecutionId in interface LockedExternalTask
    
    Returns:
    
    the id of the execution that the task is assigned to
  - getActivityId
```
public String getActivityId()
```
    Specified by:
    
    getActivityId in interface LockedExternalTask
    
    Returns:
    
    the id of the activity for which the task is created
  - getActivityInstanceId
```
public String getActivityInstanceId()
```
    Specified by:
    
    getActivityInstanceId in interface LockedExternalTask
    
    Returns:
    
    the id of the activity instance in which context the task exists
  - getProcessDefinitionId
```
public String getProcessDefinitionId()
```
    Specified by:
    
    getProcessDefinitionId in interface LockedExternalTask
    
    Returns:
    
    the id of the process definition the tasks activity belongs to
  - getProcessDefinitionKey
```
public String getProcessDefinitionKey()
```
    Specified by:
    
    getProcessDefinitionKey in interface LockedExternalTask
    
    Returns:
    
    the key of the process definition the tasks activity belongs to
  - getProcessDefinitionVersionTag
```
public String getProcessDefinitionVersionTag()
```
    Specified by:
    
    getProcessDefinitionVersionTag in interface LockedExternalTask
    
    Returns:
    
    the version tag of the process definition the tasks activity belongs to
  - getTenantId
```
public String getTenantId()
```
    Specified by:
    
    getTenantId in interface LockedExternalTask
    
    Returns:
    
    the id of the tenant the task belongs to. Can be null if the task belongs to no single tenant.
  - getVariables
```
public VariableMap getVariables()
```
    Specified by:
    
    getVariables in interface LockedExternalTask
    
    Returns:
    
    a map of variables that contains an entry for every variable that was specified at fetching time, if such a variable exists in the tasks ancestor execution hierarchy.
  - getErrorDetails
```
public String getErrorDetails()
```
    Specified by:
    
    getErrorDetails in interface LockedExternalTask
    
    Returns:
    
    error details submitted with the latest reported failure executing this task; null if no failure was reported previously or if no error details was submitted
    
    See Also:
    
    ExternalTaskService.handleFailure(String, String, String, String, int, long)
  - getPriority
```
public long getPriority()
```
    Description copied from interface: LockedExternalTask
    
    Returns the priority of the locked external task. The default priority is 0.
    
    Specified by:
    
    getPriority in interface LockedExternalTask
    
    Returns:
    
    the priority of the external task
  - getBusinessKey
```
public String getBusinessKey()
```
    Description copied from interface: LockedExternalTask
    
    Returns the business key of the process instance the external task belongs to
    
    Specified by:
    
    getBusinessKey in interface LockedExternalTask
    
    Returns:
    
    the business key
  - getExtensionProperties
```
public Map<String,String> getExtensionProperties()
```
    Description copied from interface: LockedExternalTask
    
    Returns a map of custom extension properties if the fetch instructions indicate to include extension properties. If extension properties are included, the returned map contains any extension property that is defined in the model definition of the external task. If extension properties not included or no properties are defined for the external task, the map will be empty.
    
    Specified by:
    
    getExtensionProperties in interface LockedExternalTask
    
    Returns:
    
    a map with all defined custom extension properties, never null
  - fromEntity
```
public static LockedExternalTaskImpl fromEntity(ExternalTaskEntity externalTaskEntity,
                                                List<String> variablesToFetch,
                                                boolean isLocal,
                                                boolean deserializeVariables,
                                                boolean includeExtensionProperties)
```
    Construct representation of locked ExternalTask from corresponding entity. During mapping variables will be collected,during collection variables will not be deserialized and scope will not be set to local.
    
    Parameters:
    
    externalTaskEntity - - source persistent entity to use for fields
    
    variablesToFetch - - list of variable names to fetch, if null then all variables will be fetched
    
    isLocal - - if true only local variables will be collected
    
    Returns:
    
    object with all fields copied from the ExternalTaskEntity, error details fetched from the database and variables attached

Class LockedExternalTaskImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

topicName

workerId

lockExpirationTime

retries

errorMessage

errorDetails

processInstanceId

executionId

activityId

activityInstanceId

processDefinitionId

processDefinitionKey

processDefinitionVersionTag

tenantId

priority

variables

businessKey

extensionProperties

Constructor Detail

LockedExternalTaskImpl

Method Detail

getId

getTopicName

getWorkerId

getLockExpirationTime

getRetries

getErrorMessage

getProcessInstanceId

getExecutionId

getActivityId

getActivityInstanceId

getProcessDefinitionId

getProcessDefinitionKey

getProcessDefinitionVersionTag

getTenantId

getVariables

getErrorDetails

getPriority

getBusinessKey

getExtensionProperties

fromEntity