org.activiti.engine.runtime
Interface ExecutionQuery

All Superinterfaces:

Query<ExecutionQuery,Execution>

public interface ExecutionQuery
extends Query<ExecutionQuery,Execution>

Allows programatic querying of Executions.

Author:

Joram Barrez, Frederik Heremans

Method Summary

ExecutionQuery	activityId(String activityId) Only select executions which contain an activity with the given id.
ExecutionQuery	executionId(String executionId) Only select executions with the given id.
ExecutionQuery	orderByProcessDefinitionId() Order by process definition id (needs to be followed by Query.asc() or Query.desc()).
ExecutionQuery	orderByProcessDefinitionKey() Order by process definition key (needs to be followed by Query.asc() or Query.desc()).
ExecutionQuery	orderByProcessInstanceId() Order by id (needs to be followed by Query.asc() or Query.desc()).
ExecutionQuery	processDefinitionId(String processDefinitionId) Only select executions which have the given process definition id.
ExecutionQuery	processDefinitionKey(String processDefinitionKey) Only select executions which have the given process definition key.
ExecutionQuery	processInstanceBusinessKey(String processInstanceBusinessKey) Only executions with the given business key
ExecutionQuery	processInstanceId(String processInstanceId) Only select executions which have the given process instance id.
ExecutionQuery	signalEventSubscription(String signalName) Only select executions which have a signal event subscription for the given name.
ExecutionQuery	variableValueEquals(String name, Object value) Only select executions which have a variable with the given value.
ExecutionQuery	variableValueGreaterThan(String name, Object value) Only select executions which have a variable value greater than the passed value.
ExecutionQuery	variableValueGreaterThanOrEqual(String name, Object value) Only select executions which have a variable value greater than or equal to the passed value.
ExecutionQuery	variableValueLessThan(String name, Object value) Only select executions which have a variable value less than the passed value.
ExecutionQuery	variableValueLessThanOrEqual(String name, Object value) Only select executions which have a variable value less than or equal to the passed value.
ExecutionQuery	variableValueLike(String name, String value) Only select executions which have a variable value like the given value.
ExecutionQuery	variableValueNotEquals(String name, Object value) Only select executions which have a variable with the given name, but with a different value than the passed value.

Methods inherited from interface org.activiti.engine.query.Query

asc, count, desc, list, listPage, singleResult

Method Detail

processDefinitionKey

ExecutionQuery processDefinitionKey(String processDefinitionKey)

Only select executions which have the given process definition key.

processDefinitionId

ExecutionQuery processDefinitionId(String processDefinitionId)

Only select executions which have the given process definition id.

processInstanceId

ExecutionQuery processInstanceId(String processInstanceId)

Only select executions which have the given process instance id.

processInstanceBusinessKey

ExecutionQuery processInstanceBusinessKey(String processInstanceBusinessKey)

Only executions with the given business key

executionId

ExecutionQuery executionId(String executionId)

Only select executions with the given id.

activityId

ExecutionQuery activityId(String activityId)

Only select executions which contain an activity with the given id.

variableValueEquals

ExecutionQuery variableValueEquals(String name,
                                   Object value)

Only select executions which have a variable with the given value. The type of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableTypes(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Parameters:

name - name of the variable, cannot be null.

variableValueNotEquals

ExecutionQuery variableValueNotEquals(String name,
                                      Object value)

Only select executions 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.

Parameters:

name - name of the variable, cannot be null.

variableValueGreaterThan

ExecutionQuery variableValueGreaterThan(String name,
                                        Object value)

Only select executions which have a variable value greater than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Parameters:

name - variable name, cannot be null.

value - variable value, cannot be null.

variableValueGreaterThanOrEqual

ExecutionQuery variableValueGreaterThanOrEqual(String name,
                                               Object value)

Only select executions which have a variable value greater than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Parameters:

name - variable name, cannot be null.

value - variable value, cannot be null.

variableValueLessThan

ExecutionQuery variableValueLessThan(String name,
                                     Object value)

Only select executions which have a variable value less than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Parameters:

name - variable name, cannot be null.

value - variable value, cannot be null.

variableValueLessThanOrEqual

ExecutionQuery variableValueLessThanOrEqual(String name,
                                            Object value)

Only select executions which have a variable value less than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Parameters:

name - variable name, cannot be null.

value - variable value, cannot be null.

variableValueLike

ExecutionQuery variableValueLike(String name,
                                 String value)

Only select executions which have a variable value like the given value. This be used on string variables only.

Parameters:

name - variable name, cannot be null.

value - variable value, cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).

signalEventSubscription

ExecutionQuery signalEventSubscription(String signalName)

Only select executions which have a signal event subscription for the given name.

Parameters:

signalName - the name of the signal the execution has subscribed to

orderByProcessInstanceId

ExecutionQuery orderByProcessInstanceId()

Order by id (needs to be followed by Query.asc() or Query.desc()).

orderByProcessDefinitionKey

ExecutionQuery orderByProcessDefinitionKey()

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

orderByProcessDefinitionId

ExecutionQuery orderByProcessDefinitionId()

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