org.camunda.bpm.engine.externaltask

Interface ExternalTaskQueryTopicBuilder

All Superinterfaces:

ExternalTaskQueryBuilder

All Known Implementing Classes:

ExternalTaskQueryTopicBuilderImpl

public interface ExternalTaskQueryTopicBuilder
extends ExternalTaskQueryBuilder

Author:

Thorben Lindhauer

Method Summary

Modifier and Type	Method and Description
ExternalTaskQueryTopicBuilder	businessKey(String businessKey) Define business key value to filter external tasks by (Process Instance) Business Key.
ExternalTaskQueryTopicBuilder	enableCustomObjectDeserialization() Enable deserialization of variable values that are custom objects.
ExternalTaskQueryTopicBuilder	localVariables() Define whether only local variables will be fetched with all tasks for the current topic.
ExternalTaskQueryTopicBuilder	processDefinitionId(String processDefinitionId) Define process definition id to filter external tasks by.
ExternalTaskQueryTopicBuilder	processDefinitionIdIn(String... processDefinitionIds) Define process definition ids to filter external tasksb by.
ExternalTaskQueryTopicBuilder	processDefinitionKey(String processDefinitionKey) Define process definition key to filter external tasks by.
ExternalTaskQueryTopicBuilder	processDefinitionKeyIn(String... processDefinitionKeys) Define process definition keys to filter external tasks by.
ExternalTaskQueryTopicBuilder	processDefinitionVersionTag(String versionTag) Define a process definition version tag to filter external tasks by.
ExternalTaskQueryTopicBuilder	processInstanceVariableEquals(Map<String,Object> variables) Define a HashMap of variables and their values to filter correlated tasks.
ExternalTaskQueryTopicBuilder	processInstanceVariableEquals(String name, Object value) Define a single variable and its name to filter tasks in a topic.
ExternalTaskQueryTopicBuilder	tenantIdIn(String... tenantIds) Define tenant ids to filter external tasks by.
ExternalTaskQueryTopicBuilder	variables(List<String> variables) Define variables to fetch with all tasks for the current topic.
ExternalTaskQueryTopicBuilder	variables(String... variables) Define variables to fetch with all tasks for the current topic.
ExternalTaskQueryTopicBuilder	withoutTenantId() Filter external tasks only with null tenant id.

Methods inherited from interface org.camunda.bpm.engine.externaltask.ExternalTaskQueryBuilder

execute, topic

Method Detail

variables

ExternalTaskQueryTopicBuilder variables(String... variables)

Define variables to fetch with all tasks for the current topic. Calling this method multiple times overrides the previously specified variables.

Parameters:

variables - the variable names to fetch, if null all variables will be fetched

Returns:

this builder

variables

ExternalTaskQueryTopicBuilder variables(List<String> variables)

Define variables to fetch with all tasks for the current topic. Calling this method multiple times overrides the previously specified variables.

Parameters:

variables - the variable names to fetch, if null all variables will be fetched

Returns:

this builder

processInstanceVariableEquals

ExternalTaskQueryTopicBuilder processInstanceVariableEquals(Map<String,Object> variables)

Define a HashMap of variables and their values to filter correlated tasks. Calling this method multiple times overrides the previously specified variables.

Parameters:

variables - a HashMap of the variable names (keys) and the values to filter by

Returns:

this builder

processInstanceVariableEquals

ExternalTaskQueryTopicBuilder processInstanceVariableEquals(String name,
                                                            Object value)

Define a single variable and its name to filter tasks in a topic. Multiple calls to this method add to the existing "variable filters".

Parameters:

name - the name of the variable you want to fetch and query by

value - the value of the variable which you want to filter

Returns:

this builder

businessKey

ExternalTaskQueryTopicBuilder businessKey(String businessKey)

Define business key value to filter external tasks by (Process Instance) Business Key.

Parameters:

businessKey - the value of the Business Key to filter by

Returns:

this builder

processDefinitionId

ExternalTaskQueryTopicBuilder processDefinitionId(String processDefinitionId)

Define process definition id to filter external tasks by.

Parameters:

processDefinitionId - the definition id to filter by

Returns:

this builder

processDefinitionIdIn

ExternalTaskQueryTopicBuilder processDefinitionIdIn(String... processDefinitionIds)

Define process definition ids to filter external tasksb by.

Parameters:

processDefinitionIds - the definition ids to filter by

Returns:

this builder

processDefinitionKey

ExternalTaskQueryTopicBuilder processDefinitionKey(String processDefinitionKey)

Define process definition key to filter external tasks by.

Parameters:

processDefinitionKey - the definition key to filter by

Returns:

this builder

processDefinitionKeyIn

ExternalTaskQueryTopicBuilder processDefinitionKeyIn(String... processDefinitionKeys)

Define process definition keys to filter external tasks by.

Parameters:

processDefinitionKey - the definition keys to filter by

Returns:

this builder

processDefinitionVersionTag

ExternalTaskQueryTopicBuilder processDefinitionVersionTag(String versionTag)

Define a process definition version tag to filter external tasks by.

Parameters:

versionTag - the version tag to filter by

Returns:

this builder

withoutTenantId

ExternalTaskQueryTopicBuilder withoutTenantId()

Filter external tasks only with null tenant id.

Returns:

this builder

tenantIdIn

ExternalTaskQueryTopicBuilder tenantIdIn(String... tenantIds)

Define tenant ids to filter external tasks by.

Parameters:

tenantIds - the tenant ids to filter by

Returns:

this builder

enableCustomObjectDeserialization

ExternalTaskQueryTopicBuilder enableCustomObjectDeserialization()

Enable deserialization of variable values that are custom objects. By default, the query will not attempt to deserialize the value of these variables.

Returns:

this builder

localVariables

ExternalTaskQueryTopicBuilder localVariables()

Define whether only local variables will be fetched with all tasks for the current topic.

Returns:

this builder