Package org.camunda.bpm.engine.externaltask

Interface ExternalTaskQuery

All Superinterfaces:
Query<ExternalTaskQuery,ExternalTask>
All Known Implementing Classes:
ExternalTaskQueryImpl
public interface ExternalTaskQuery extends Query<ExternalTaskQuery,ExternalTask>
Author:
Thorben Lindhauer, Christopher Zell

  • Method Details

    • externalTaskId

      ExternalTaskQuery externalTaskId(String externalTaskId)
      Only select the external task with the given id

    • externalTaskIdIn

      ExternalTaskQuery externalTaskIdIn(Set<String> externalTaskIds)
      Only select external tasks with any of the given ids

    • workerId

      ExternalTaskQuery workerId(String workerId)
      Only select external tasks that was most recently locked by the given worker

    • lockExpirationBefore

      ExternalTaskQuery lockExpirationBefore(Date lockExpirationDate)
      Only select external tasks that have a lock expiring before the given date

    • lockExpirationAfter

      ExternalTaskQuery lockExpirationAfter(Date lockExpirationDate)
      Only select external tasks that have a lock expiring after the given date

    • topicName

      ExternalTaskQuery topicName(String topicName)
      Only select external tasks of the given topic

    • locked

      ExternalTaskQuery locked()
      Only select external tasks that are currently locked, i.e. that have a lock expiration time that is in the future

    • notLocked

      ExternalTaskQuery notLocked()
      Only select external tasks that are not currently locked, i.e. that have no lock expiration time or one that is overdue

    • executionId

      ExternalTaskQuery executionId(String executionId)
      Only select external tasks created in the context of the given execution

    • processInstanceId

      ExternalTaskQuery processInstanceId(String processInstanceId)
      Only select external tasks created in the context of the given process instance

    • processInstanceIdIn

      ExternalTaskQuery processInstanceIdIn(String... processInstanceIdIn)
      Only select external tasks created in the context of the given process instances

    • processDefinitionKey

      ExternalTaskQuery processDefinitionKey(String processDefinitionKey)
      Only select tasks which are part of a process instance which has the given process definition key.

    • processDefinitionKeyIn

      ExternalTaskQuery processDefinitionKeyIn(String... processDefinitionKeys)
      Only select tasks which are part of a process instance which has one of the given process definition keys.

    • processDefinitionId

      ExternalTaskQuery processDefinitionId(String processDefinitionId)
      Only select external tasks that belong to an instance of the given process definition

    • processDefinitionName

      ExternalTaskQuery processDefinitionName(String processDefinitionName)
      Only select tasks which are part of a process instance which has the given process definition name.

    • processDefinitionNameLike

      ExternalTaskQuery processDefinitionNameLike(String processDefinitionName)
      Only select tasks which are part of a process instance which process definition name is like the given parameter. The syntax is that of SQL: for example usage: nameLike(%processDefinitionName%)

    • activityId

      ExternalTaskQuery activityId(String activityId)
      Only select external tasks that belong to an instance of the given activity

    • activityIdIn

      ExternalTaskQuery activityIdIn(String... activityIdIn)
      Only select external tasks that belong to an instances of the given activities.

    • priorityHigherThanOrEquals

      ExternalTaskQuery priorityHigherThanOrEquals(long priority)
      Only select external tasks with a priority that is higher than or equal to the given priority.
      Parameters:
      priority - the priority which is used for the query
      Returns:
      the builded external task query
      Since:
      7.5

    • priorityLowerThanOrEquals

      ExternalTaskQuery priorityLowerThanOrEquals(long priority)
      Only select external tasks with a priority that is lower than or equal to the given priority.
      Parameters:
      priority - the priority which is used for the query
      Returns:
      the builded external task query
      Since:
      7.5

    • processVariableValueEquals

      ExternalTaskQuery processVariableValueEquals(String variableName, Object variableValue)
      Only select tasks which have are part of a process that have a variable with the given name set to the given value.

    • processVariableValueNotEquals

      ExternalTaskQuery processVariableValueNotEquals(String variableName, Object variableValue)
      Only select tasks which have a variable with the given name, but with a different value than the passed value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

    • processVariableValueLike

      ExternalTaskQuery processVariableValueLike(String variableName, String variableValue)
      Only select tasks which are part of a process that have a variable with the given name and matching the given value. The syntax is that of SQL: for example usage: valueLike(%value%)

    • processVariableValueNotLike

      ExternalTaskQuery processVariableValueNotLike(String variableName, String variableValue)
      Only select tasks which are part of a process that have a variable with the given name and not matching the given value. The syntax is that of SQL: for example usage: valueNotLike(%value%)

    • processVariableValueGreaterThan

      ExternalTaskQuery processVariableValueGreaterThan(String variableName, Object variableValue)
      Only select tasks which are part of a process that have a variable with the given name and a value greater than the given one.

    • processVariableValueGreaterThanOrEquals

      ExternalTaskQuery processVariableValueGreaterThanOrEquals(String variableName, Object variableValue)
      Only select tasks which are part of a process that have a variable with the given name and a value greater than or equal to the given one.

    • processVariableValueLessThan

      ExternalTaskQuery processVariableValueLessThan(String variableName, Object variableValue)
      Only select tasks which are part of a process that have a variable with the given name and a value less than the given one.

    • processVariableValueLessThanOrEquals

      ExternalTaskQuery processVariableValueLessThanOrEquals(String variableName, Object variableValue)
      Only select tasks which are part of a process that have a variable with the given name and a value greater than or equal to the given one.

    • matchVariableNamesIgnoreCase

      ExternalTaskQuery matchVariableNamesIgnoreCase()
      All queries for task-, process- and case-variables will match the variable names in a case-insensitive way.

    • matchVariableValuesIgnoreCase

      ExternalTaskQuery matchVariableValuesIgnoreCase()
      All queries for task-, process- and case-variables will match the variable values in a case-insensitive way.

    • suspended

      ExternalTaskQuery suspended()
      Only select external tasks that are currently suspended

    • active

      ExternalTaskQuery active()
      Only select external tasks that are currently not suspended

    • withRetriesLeft

      ExternalTaskQuery withRetriesLeft()
      Only select external tasks that have retries > 0

    • noRetriesLeft

      ExternalTaskQuery noRetriesLeft()
      Only select external tasks that have retries = 0

    • tenantIdIn

      ExternalTaskQuery tenantIdIn(String... tenantIds)
      Only select external tasks that belong to one of the given tenant ids.

    • orderById

      ExternalTaskQuery orderById()
      Order by external task id (needs to be followed by Query.asc() or Query.desc()).

    • orderByLockExpirationTime

      ExternalTaskQuery orderByLockExpirationTime()
      Order by lock expiration time (needs to be followed by Query.asc() or Query.desc()). Ordering of tasks with no lock expiration time is database-dependent.

    • orderByProcessInstanceId

      ExternalTaskQuery orderByProcessInstanceId()
      Order by process instance id (needs to be followed by Query.asc() or Query.desc()).

    • orderByProcessDefinitionId

      ExternalTaskQuery orderByProcessDefinitionId()
      Order by process definition id (needs to be followed by Query.asc() or Query.desc()).

    • orderByProcessDefinitionKey

      ExternalTaskQuery orderByProcessDefinitionKey()
      Order by process definition key (needs to be followed by Query.asc() or Query.desc()).

    • orderByTenantId

      ExternalTaskQuery orderByTenantId()
      Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of external tasks without tenant id is database-specific.

    • orderByPriority

      ExternalTaskQuery orderByPriority()
      Order by priority (needs to be followed by Query.asc() or Query.desc()).
      Since:
      7.5

    • orderByCreateTime

      ExternalTaskQuery orderByCreateTime()
      Order by create time (needs to be followed by Query.asc() or Query.desc()).