org.camunda.bpm.engine.runtime
Interface ExecutionQuery

All Superinterfaces:

Query<ExecutionQuery,Execution>

All Known Implementing Classes:

ExecutionQueryImpl

public interface ExecutionQuery
extends Query<ExecutionQuery,Execution>

Allows programmatic querying of Executions.

Author:

Joram Barrez, Frederik Heremans

Method Summary

ExecutionQuery	active() Only selects executions which are active (i.e.
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	incidentId(String incidentId) Only selects executions with the given incident id.
ExecutionQuery	incidentMessage(String incidentMessage) Only selects executions with the given incident message.
ExecutionQuery	incidentMessageLike(String incidentMessageLike) Only selects executions with an incident message like the given.
ExecutionQuery	incidentType(String incidentType) Only selects executions with the given incident type.
ExecutionQuery	messageEventSubscription() Only select executions that have a message event subscription.
ExecutionQuery	messageEventSubscriptionName(String messageName) Only select executions which have a message event subscription for the given messageName.
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 select executions that belong to a process instance with the given business key
ExecutionQuery	processInstanceId(String processInstanceId) Only select executions which have the given process instance id.
ExecutionQuery	processVariableValueEquals(String variableName, Object variableValue) Only select executions which are part of a process that have a variable with the given name set to the given value.
ExecutionQuery	processVariableValueNotEquals(String variableName, Object variableValue) Only select executions which are part of a process that have a variable with the given name, but with a different value than the passed value.
ExecutionQuery	signalEventSubscription(String signalName) Deprecated.
ExecutionQuery	signalEventSubscriptionName(String signalName) Only select executions which have a signal event subscription for the given signal name.
ExecutionQuery	suspended() Only selects executions which are suspended, because their process instance is suspended.
ExecutionQuery	variableValueEquals(String name, Object value) Only select executions which have a local variable with the given value.
ExecutionQuery	variableValueGreaterThan(String name, Object value) Only select executions which have a local variable value greater than the passed value.
ExecutionQuery	variableValueGreaterThanOrEqual(String name, Object value) Only select executions which have a local variable value greater than or equal to the passed value.
ExecutionQuery	variableValueLessThan(String name, Object value) Only select executions which have a local variable value less than the passed value.
ExecutionQuery	variableValueLessThanOrEqual(String name, Object value) Only select executions which have a local variable value less than or equal to the passed value.
ExecutionQuery	variableValueLike(String name, String value) Only select executions which have a local variable value like the given value.
ExecutionQuery	variableValueNotEquals(String name, Object value) Only select executions which have a local variable with the given name, but with a different value than the passed value.

Methods inherited from interface org.camunda.bpm.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 select executions that belong to a process instance 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 local variable with the given value. The type of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableSerializers(). 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 local 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 local 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 local 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 local 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 local 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 local 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%).

processVariableValueEquals

ExecutionQuery processVariableValueEquals(String variableName,
                                          Object variableValue)

Only select executions which are part of a process that have a variable with the given name set to the given value.

processVariableValueNotEquals

ExecutionQuery processVariableValueNotEquals(String variableName,
                                             Object variableValue)

Only select executions which are part of a process that 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.

signalEventSubscription

@Deprecated
ExecutionQuery signalEventSubscription(String signalName)

Deprecated.

See Also:

signalEventSubscriptionName(String)

signalEventSubscriptionName

ExecutionQuery signalEventSubscriptionName(String signalName)

Only select executions which have a signal event subscription for the given signal name. (The signalName is specified using the 'name' attribute of the signal element in the BPMN 2.0 XML.)

Parameters:

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

messageEventSubscriptionName

ExecutionQuery messageEventSubscriptionName(String messageName)

Only select executions which have a message event subscription for the given messageName. (The messageName is specified using the 'name' attribute of the message element in the BPMN 2.0 XML.)

Parameters:

messageName - the name of the message the execution has subscribed to

messageEventSubscription

ExecutionQuery messageEventSubscription()

Only select executions that have a message event subscription. Use messageEventSubscriptionName(String) to filter for executions with message event subscriptions with a certain name.

suspended

ExecutionQuery suspended()

Only selects executions which are suspended, because their process instance is suspended.

active

ExecutionQuery active()

Only selects executions which are active (i.e. not suspended).

incidentType

ExecutionQuery incidentType(String incidentType)

Only selects executions with the given incident type.

incidentId

ExecutionQuery incidentId(String incidentId)

Only selects executions with the given incident id.

incidentMessage

ExecutionQuery incidentMessage(String incidentMessage)

Only selects executions with the given incident message.

incidentMessageLike

ExecutionQuery incidentMessageLike(String incidentMessageLike)

Only selects executions with an incident message like the given.

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