Package org.camunda.bpm.engine.externaltask

Interface ExternalTask

  • 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 Detail

      • getId

        java.lang.String getId()
        Returns:
        the id of the task

      • getTopicName

        java.lang.String getTopicName()
        Returns:
        the name of the topic the task belongs to

      • getWorkerId

        java.lang.String getWorkerId()
        Returns:
        the id of the worker that has locked the task

      • getLockExpirationTime

        java.util.Date getLockExpirationTime()
        Returns:
        the absolute time at which the lock expires

      • getProcessInstanceId

        java.lang.String getProcessInstanceId()
        Returns:
        the id of the process instance the task exists in

      • getExecutionId

        java.lang.String getExecutionId()
        Returns:
        the id of the execution that the task is assigned to

      • getActivityId

        java.lang.String getActivityId()
        Returns:
        the id of the activity for which the task is created

      • getActivityInstanceId

        java.lang.String getActivityInstanceId()
        Returns:
        the id of the activity instance in which context the task exists

      • getProcessDefinitionId

        java.lang.String getProcessDefinitionId()
        Returns:
        the id of the process definition the tasks activity belongs to

      • getProcessDefinitionKey

        java.lang.String getProcessDefinitionKey()
        Returns:
        the key of the process definition the tasks activity belongs to

      • getProcessDefinitionVersionTag

        java.lang.String getProcessDefinitionVersionTag()
        Returns:
        the version tag of the process definition the tasks activity belongs to

      • getRetries

        java.lang.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

        java.lang.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

      • isSuspended

        boolean isSuspended()
        Returns:
        true if the external task is suspended; a suspended external task cannot be completed, thereby preventing process continuation

      • getTenantId

        java.lang.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

        java.util.Map<java.lang.String,​java.lang.String> getExtensionProperties()
        Returns a map containing all custom extension properties of the external task.
        Returns:
        the properties, never null

      • getBusinessKey

        java.lang.String getBusinessKey()
        Returns the business key of the process instance the external task belongs to
        Returns:
        the business key