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

Class ExternalTaskImpl

  • All Implemented Interfaces:
    ExternalTask
    public class ExternalTaskImpl
extends java.lang.Object
implements ExternalTask
    Author:
    Tassilo Weidner

    • Field Detail

      • activityId

        protected java.lang.String activityId

      • activityInstanceId

        protected java.lang.String activityInstanceId

      • errorMessage

        protected java.lang.String errorMessage

      • errorDetails

        protected java.lang.String errorDetails

      • executionId

        protected java.lang.String executionId

      • id

        protected java.lang.String id

      • lockExpirationTime

        protected java.util.Date lockExpirationTime

      • processDefinitionId

        protected java.lang.String processDefinitionId

      • processDefinitionKey

        protected java.lang.String processDefinitionKey

      • processDefinitionVersionTag

        protected java.lang.String processDefinitionVersionTag

      • processInstanceId

        protected java.lang.String processInstanceId

      • retries

        protected java.lang.Integer retries

      • workerId

        protected java.lang.String workerId

      • topicName

        protected java.lang.String topicName

      • tenantId

        protected java.lang.String tenantId

      • priority

        protected long priority

      • variables

        protected java.util.Map<java.lang.String,​TypedValueField> variables

      • businessKey

        protected java.lang.String businessKey

      • extensionProperties

        protected java.util.Map<java.lang.String,​java.lang.String> extensionProperties

      • receivedVariableMap

        protected java.util.Map<java.lang.String,​VariableValue> receivedVariableMap

    • Constructor Detail

      • ExternalTaskImpl

        public ExternalTaskImpl()

    • Method Detail

      • setActivityId

        public void setActivityId​(java.lang.String activityId)

      • setActivityInstanceId

        public void setActivityInstanceId​(java.lang.String activityInstanceId)

      • setErrorMessage

        public void setErrorMessage​(java.lang.String errorMessage)

      • setErrorDetails

        public void setErrorDetails​(java.lang.String errorDetails)

      • setExecutionId

        public void setExecutionId​(java.lang.String executionId)

      • setId

        public void setId​(java.lang.String id)

      • setLockExpirationTime

        public void setLockExpirationTime​(java.util.Date lockExpirationTime)

      • setProcessDefinitionId

        public void setProcessDefinitionId​(java.lang.String processDefinitionId)

      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(java.lang.String processDefinitionKey)

      • setProcessDefinitionVersionTag

        public void setProcessDefinitionVersionTag​(java.lang.String processDefinitionVersionTag)

      • setProcessInstanceId

        public void setProcessInstanceId​(java.lang.String processInstanceId)

      • setRetries

        public void setRetries​(java.lang.Integer retries)

      • setWorkerId

        public void setWorkerId​(java.lang.String workerId)

      • setTopicName

        public void setTopicName​(java.lang.String topicName)

      • setTenantId

        public void setTenantId​(java.lang.String tenantId)

      • setPriority

        public void setPriority​(long priority)

      • setVariables

        public void setVariables​(java.util.Map<java.lang.String,​TypedValueField> variables)

      • setBusinessKey

        public void setBusinessKey​(java.lang.String businessKey)

      • getVariables

        public java.util.Map<java.lang.String,​TypedValueField> getVariables()

      • setReceivedVariableMap

        public void setReceivedVariableMap​(java.util.Map<java.lang.String,​VariableValue> receivedVariableMap)

      • getActivityId

        public java.lang.String getActivityId()
        Specified by:
        getActivityId in interface ExternalTask
        Returns:
        the id of the activity that this external task belongs to

      • getActivityInstanceId

        public java.lang.String getActivityInstanceId()
        Specified by:
        getActivityInstanceId in interface ExternalTask
        Returns:
        the id of the activity instance that the external task belongs to

      • getErrorMessage

        public java.lang.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 java.lang.String getErrorDetails()
        Specified by:
        getErrorDetails in interface ExternalTask
        Returns:
        the error details submitted with the latest reported failure executing this task

      • getExecutionId

        public java.lang.String getExecutionId()
        Specified by:
        getExecutionId in interface ExternalTask
        Returns:
        the id of the execution that the external task belongs to

      • getId

        public java.lang.String getId()
        Specified by:
        getId in interface ExternalTask
        Returns:
        the id of the external task

      • getLockExpirationTime

        public java.util.Date getLockExpirationTime()
        Specified by:
        getLockExpirationTime in interface ExternalTask
        Returns:
        the date that the task's most recent lock expires or has expired

      • getProcessDefinitionId

        public java.lang.String getProcessDefinitionId()
        Specified by:
        getProcessDefinitionId in interface ExternalTask
        Returns:
        the id of the process definition the external task is defined in

      • getProcessDefinitionKey

        public java.lang.String getProcessDefinitionKey()
        Specified by:
        getProcessDefinitionKey in interface ExternalTask
        Returns:
        the key of the process definition the external task is defined in

      • getProcessDefinitionVersionTag

        public java.lang.String getProcessDefinitionVersionTag()
        Specified by:
        getProcessDefinitionVersionTag in interface ExternalTask
        Returns:
        the version tag of the process definition the tasks activity belongs to

      • getProcessInstanceId

        public java.lang.String getProcessInstanceId()
        Specified by:
        getProcessInstanceId in interface ExternalTask
        Returns:
        the id of the process instance the external task belongs to

      • getRetries

        public java.lang.Integer getRetries()
        Specified by:
        getRetries in interface ExternalTask
        Returns:
        the number of retries the task currently has left

      • getWorkerId

        public java.lang.String getWorkerId()
        Specified by:
        getWorkerId in interface ExternalTask
        Returns:
        the id of the worker that possesses or possessed the most recent lock

      • getTopicName

        public java.lang.String getTopicName()
        Specified by:
        getTopicName in interface ExternalTask
        Returns:
        the topic name of the external task

      • getTenantId

        public java.lang.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 java.lang.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 java.util.Map<java.lang.String,​java.lang.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​(java.lang.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 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 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 TypedValue> T getVariableTyped​(java.lang.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 TypedValue> T getVariableTyped​(java.lang.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 java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.String> extensionProperties)

      • getExtensionProperty

        public java.lang.String getExtensionProperty​(java.lang.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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object