Package org.camunda.bpm.client.task.impl

Class ExternalTaskImpl

java.lang.Object

org.camunda.bpm.client.task.impl.ExternalTaskImpl

All Implemented Interfaces:

ExternalTask

public class ExternalTaskImpl
extends Object
implements ExternalTask

Author:

Tassilo Weidner

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 Map<String,VariableValue>	receivedVariableMap
protected Integer	retries
protected String	tenantId
protected String	topicName
protected Map<String,TypedValueField>	variables
protected String	workerId

Constructor Summary

Constructors

Constructor	Description
ExternalTaskImpl()

Method Summary

Modifier and Type	Method	Description
String	getActivityId()
String	getActivityInstanceId()
Map<String,Object>	getAllVariables()	Returns untyped variables that exist in the task's ancestor execution hierarchy
org.camunda.bpm.engine.variable.VariableMap	getAllVariablesTyped()	Returns typed variables that exist in the task's ancestor execution hierarchy
org.camunda.bpm.engine.variable.VariableMap	getAllVariablesTyped(boolean deserializeObjectValues)	Returns typed variables that exist in the task's ancestor execution hierarchy
String	getBusinessKey()	Returns the business key of the process instance the external task is associated with
String	getErrorDetails()
String	getErrorMessage()
String	getExecutionId()
Map<String,String>	getExtensionProperties()	Returns all available extension properties.
String	getExtensionProperty(String propertyKey)	Returns the value of the extension property for a given key or null if the property was not available.
String	getId()
Date	getLockExpirationTime()
long	getPriority()
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
String	getProcessDefinitionVersionTag()
String	getProcessInstanceId()
Integer	getRetries()
String	getTenantId()
String	getTopicName()
<T> T	getVariable(String variableName)	Returns an untyped variable of the task's ancestor execution hierarchy
Map<String,TypedValueField>	getVariables()
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getVariableTyped(String variableName)	Returns a typed variable of the task's ancestor execution hierarchy
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getVariableTyped(String variableName, boolean deserializeObjectValues)	Returns a typed variable of the task's ancestor execution hierarchy
String	getWorkerId()
void	setActivityId(String activityId)
void	setActivityInstanceId(String activityInstanceId)
void	setBusinessKey(String businessKey)
void	setErrorDetails(String errorDetails)
void	setErrorMessage(String errorMessage)
void	setExecutionId(String executionId)
void	setExtensionProperties(Map<String,String> extensionProperties)
void	setId(String id)
void	setLockExpirationTime(Date lockExpirationTime)
void	setPriority(long priority)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionVersionTag(String processDefinitionVersionTag)
void	setProcessInstanceId(String processInstanceId)
void	setReceivedVariableMap(Map<String,VariableValue> receivedVariableMap)
void	setRetries(Integer retries)
void	setTenantId(String tenantId)
void	setTopicName(String topicName)
void	setVariables(Map<String,TypedValueField> variables)
void	setWorkerId(String workerId)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

activityId

protected String activityId

activityInstanceId

protected String activityInstanceId

errorMessage

protected String errorMessage

errorDetails

protected String errorDetails

executionId

protected String executionId

id

protected String id

lockExpirationTime

protected Date lockExpirationTime

processDefinitionId

protected String processDefinitionId

processDefinitionKey

protected String processDefinitionKey

processDefinitionVersionTag

protected String processDefinitionVersionTag

processInstanceId

protected String processInstanceId

retries

protected Integer retries

workerId

protected String workerId

topicName

protected String topicName

tenantId

protected String tenantId

priority

protected long priority

variables

protected Map<String,TypedValueField> variables

businessKey

protected String businessKey

extensionProperties

protected Map<String,String> extensionProperties

receivedVariableMap

protected Map<String,VariableValue> receivedVariableMap

Constructor Detail

ExternalTaskImpl

public ExternalTaskImpl()

Method Detail

setActivityId

public void setActivityId(String activityId)

setActivityInstanceId

public void setActivityInstanceId(String activityInstanceId)

setErrorMessage

public void setErrorMessage(String errorMessage)

setErrorDetails

public void setErrorDetails(String errorDetails)

setExecutionId

public void setExecutionId(String executionId)

setId

public void setId(String id)

setLockExpirationTime

public void setLockExpirationTime(Date lockExpirationTime)

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

setProcessDefinitionKey

public void setProcessDefinitionKey(String processDefinitionKey)

setProcessDefinitionVersionTag

public void setProcessDefinitionVersionTag(String processDefinitionVersionTag)

setProcessInstanceId

public void setProcessInstanceId(String processInstanceId)

setRetries

public void setRetries(Integer retries)

setWorkerId

public void setWorkerId(String workerId)

setTopicName

public void setTopicName(String topicName)

setTenantId

public void setTenantId(String tenantId)

setPriority

public void setPriority(long priority)

setVariables

public void setVariables(Map<String,TypedValueField> variables)

setBusinessKey

public void setBusinessKey(String businessKey)

getVariables

public Map<String,TypedValueField> getVariables()

setReceivedVariableMap

public void setReceivedVariableMap(Map<String,VariableValue> receivedVariableMap)

getActivityId

public String getActivityId()

Specified by:

getActivityId in interface ExternalTask

Returns:

the id of the activity that this external task belongs to

getActivityInstanceId

public String getActivityInstanceId()

Specified by:

getActivityInstanceId in interface ExternalTask

Returns:

the id of the activity instance that the external task belongs to

getErrorMessage

public String getErrorMessage()

Specified by:

getErrorMessage in interface ExternalTask

Returns:

the error message that was supplied when the last failure of this task was reported

getErrorDetails

public String getErrorDetails()

Specified by:

getErrorDetails in interface ExternalTask

Returns:

the error details submitted with the latest reported failure executing this task

getExecutionId

public String getExecutionId()

Specified by:

getExecutionId in interface ExternalTask

Returns:

the id of the execution that the external task belongs to

getId

public String getId()

Specified by:

getId in interface ExternalTask

Returns:

the id of the external task

getLockExpirationTime

public Date getLockExpirationTime()

Specified by:

getLockExpirationTime in interface ExternalTask

Returns:

the date that the task's most recent lock expires or has expired

getProcessDefinitionId

public String getProcessDefinitionId()

Specified by:

getProcessDefinitionId in interface ExternalTask

Returns:

the id of the process definition the external task is defined in

getProcessDefinitionKey

public String getProcessDefinitionKey()

Specified by:

getProcessDefinitionKey in interface ExternalTask

Returns:

the key of the process definition the external task is defined in

getProcessDefinitionVersionTag

public String getProcessDefinitionVersionTag()

Specified by:

getProcessDefinitionVersionTag in interface ExternalTask

Returns:

the version tag of the process definition the tasks activity belongs to

getProcessInstanceId

public String getProcessInstanceId()

Specified by:

getProcessInstanceId in interface ExternalTask

Returns:

the id of the process instance the external task belongs to

getRetries

public Integer getRetries()

Specified by:

getRetries in interface ExternalTask

Returns:

the number of retries the task currently has left

getWorkerId

public String getWorkerId()

Specified by:

getWorkerId in interface ExternalTask

Returns:

the id of the worker that possesses or possessed the most recent lock

getTopicName

public String getTopicName()

Specified by:

getTopicName in interface ExternalTask

Returns:

the topic name of the external task

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface ExternalTask

Returns:

the id of the tenant the external task belongs to

getPriority

public long getPriority()

Specified by:

getPriority in interface ExternalTask

Returns:

the priority of the external task

getBusinessKey

public String getBusinessKey()

Description copied from interface: ExternalTask

Returns the business key of the process instance the external task is associated with

Specified by:

getBusinessKey in interface ExternalTask

Returns:

the business key

getAllVariables

public Map<String,Object> getAllVariables()

Description copied from interface: ExternalTask

Returns untyped variables that exist in the task's ancestor execution hierarchy

Specified by:

getAllVariables in interface ExternalTask

Returns:

a map of untyped variables that contains an entry for each variable

getVariable

public <T> T getVariable(String variableName)

Description copied from interface: ExternalTask

Returns an untyped variable of the task's ancestor execution hierarchy

Specified by:

getVariable in interface ExternalTask

Type Parameters:

T - the type of the variable

Parameters:

variableName - of the variable to be returned

Returns:

• an untyped variable if such a named variable exists
• null if such a named variable not exists

getAllVariablesTyped

public org.camunda.bpm.engine.variable.VariableMap getAllVariablesTyped()

Description copied from interface: ExternalTask

Returns typed variables that exist in the task's ancestor execution hierarchy

Specified by:

getAllVariablesTyped in interface ExternalTask

Returns:

a map of typed variables that contains an entry for each variable

getAllVariablesTyped

public org.camunda.bpm.engine.variable.VariableMap getAllVariablesTyped(boolean deserializeObjectValues)

Description copied from interface: ExternalTask

Returns typed variables that exist in the task's ancestor execution hierarchy

Specified by:

getAllVariablesTyped in interface ExternalTask

Parameters:

deserializeObjectValues -

• false to retrieve the object without deserialization
• true to retrieve the deserialized object

Returns:

a map of typed variables that contains an entry for each variable

getVariableTyped

public <T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableTyped(String variableName)

Description copied from interface: ExternalTask

Returns a typed variable of the task's ancestor execution hierarchy

Specified by:

getVariableTyped in interface ExternalTask

Type Parameters:

T - the type of the variable

Parameters:

variableName - of the variable to be returned

Returns:

• a typed variable if such a named variable exists
• null if such a named variable not exists

getVariableTyped

public <T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableTyped(String variableName,
                                                                                       boolean deserializeObjectValues)

Description copied from interface: ExternalTask

Returns a typed variable of the task's ancestor execution hierarchy

Specified by:

getVariableTyped in interface ExternalTask

Type Parameters:

T - the type of the variable

Parameters:

variableName - of the variable to be returned

deserializeObjectValues -

• false to retrieve the object without deserialization
• true to retrieve the deserialized object

Returns:

• a typed variable if such a named variable exists
• null if such a named variable not exists

getExtensionProperties

public Map<String,String> getExtensionProperties()

Description copied from interface: ExternalTask

Returns all available extension properties. Extension properties must be defined at the external task activity inside the BPMN model and explicitly fetched (e.g. by calling TopicSubscriptionBuilder.includeExtensionProperties(boolean)) to be available. If no extension properties are available the returned map will be empty.

Specified by:

getExtensionProperties in interface ExternalTask

Returns:

a map of available extension properties, never null

setExtensionProperties

public void setExtensionProperties(Map<String,String> extensionProperties)

getExtensionProperty

public String getExtensionProperty(String propertyKey)

Description copied from interface: ExternalTask

Returns the value of the extension property for a given key or null if the property was not available.

Specified by:

getExtensionProperty in interface ExternalTask

Returns:

the extension property, or null if not available

See Also:

ExternalTask.getExtensionProperties()

toString

public String toString()

Overrides:

toString in class Object