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

Methods

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

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

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