Package org.camunda.bpm.engine.externaltask

Interface LockedExternalTask

  • All Known Implementing Classes:
    LockedExternalTaskImpl
    public interface LockedExternalTask
    Represents an external task that was fetched and locked.
    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.

      • getVariables

        VariableMap getVariables()
        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.

      • 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 locked external task. The default priority is 0.
        Returns:
        the priority of the external task

      • getBusinessKey

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

      • getExtensionProperties

        java.util.Map<java.lang.String,​java.lang.String> getExtensionProperties()
        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.
        Returns:
        a map with all defined custom extension properties, never null