org.activiti.engine.impl

Class ExecutionQueryImpl

java.lang.Object

org.activiti.engine.impl.db.ListQueryParameterObject

org.activiti.engine.impl.AbstractQuery<T,U>

org.activiti.engine.impl.AbstractVariableQueryImpl<ExecutionQuery,Execution>

org.activiti.engine.impl.ExecutionQueryImpl

All Implemented Interfaces:

Serializable, Command<Object>, Query<ExecutionQuery,Execution>, ExecutionQuery

public class ExecutionQueryImpl
extends AbstractVariableQueryImpl<ExecutionQuery,Execution>
implements ExecutionQuery

Author:

Joram Barrez, Frederik Heremans, Daniel Meyer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	activityId
protected String	businessKey
protected List<EventSubscriptionQueryValue>	eventSubscriptions
protected boolean	excludeSubprocesses
protected String	executionId
protected boolean	includeChildExecutionsWithBusinessKeyQuery
protected String	involvedUser
protected boolean	isActive
protected String	parentId
protected String	processDefinitionId
protected String	processDefinitionKey
protected String	processDefinitionName
protected String	processInstanceId
protected String	subProcessInstanceId
protected String	superProcessInstanceId
protected SuspensionState	suspensionState

Fields inherited from class org.activiti.engine.impl.AbstractVariableQueryImpl

queryVariableValues

Fields inherited from class org.activiti.engine.impl.AbstractQuery

commandContext, commandExecutor, orderBy, orderProperty, resultType, SORTORDER_ASC, SORTORDER_DESC

Fields inherited from class org.activiti.engine.impl.db.ListQueryParameterObject

databaseType, firstResult, maxResults, parameter

Constructor Summary

Constructors

Constructor and Description
ExecutionQueryImpl()
ExecutionQueryImpl(CommandContext commandContext)
ExecutionQueryImpl(CommandExecutor commandExecutor)

Method Summary

Methods

Modifier and Type	Method and Description
ExecutionQueryImpl	activityId(String activityId) Only select executions which contain an activity with the given id.
ExecutionQuery	eventSubscription(String eventType, String eventName)
long	executeCount(CommandContext commandContext)
List<Execution>	executeList(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.
ExecutionQueryImpl	executionId(String executionId) Only select executions with the given id.
String	getActivityId()
String	getBusinessKey()
List<EventSubscriptionQueryValue>	getEventSubscriptions()
String	getExecutionId()
String	getInvolvedUser()
boolean	getOnlyProcessInstances()
String	getParentId()
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
String	getProcessDefinitionName()
String	getProcessInstanceId()
String	getProcessInstanceIds()
String	getSubProcessInstanceId()
String	getSuperProcessInstanceId()
SuspensionState	getSuspensionState()
boolean	isActive()
boolean	isExcludeSubprocesses()
boolean	isIncludeChildExecutionsWithBusinessKeyQuery()
boolean	isProcessInstancesOnly()
ExecutionQuery	messageEventSubscriptionName(String messageName) Only select executions which have a message event subscription for the given messageName.
ExecutionQueryImpl	orderByProcessDefinitionId() Order by process definition id (needs to be followed by Query.asc() or Query.desc()).
ExecutionQueryImpl	orderByProcessDefinitionKey() Order by process definition key (needs to be followed by Query.asc() or Query.desc()).
ExecutionQueryImpl	orderByProcessInstanceId() Order by id (needs to be followed by Query.asc() or Query.desc()).
ExecutionQueryImpl	parentId(String parentId) Only select executions which are a direct child-execution of the execution with the given id.
ExecutionQueryImpl	processDefinitionId(String processDefinitionId) Only select executions which have the given process definition id.
ExecutionQueryImpl	processDefinitionKey(String processDefinitionKey) Only select executions which have the given process definition key.
ExecutionQuery	processDefinitionName(String processDefinitionName) Only select executions which have the given process definition name.
ExecutionQuery	processInstanceBusinessKey(String businessKey) Only executions with the given business key.
ExecutionQuery	processInstanceBusinessKey(String processInstanceBusinessKey, boolean includeChildExecutions) Only executions with the given business key.
ExecutionQueryImpl	processInstanceId(String processInstanceId) Only select executions which have the given process instance id.
ExecutionQuery	processVariableValueEquals(Object variableValue) Only select executions which are part of a process that have at least one variable with the given value.
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	processVariableValueEqualsIgnoreCase(String name, String value) Only select executions which are part of a process that have a local string variable with the given value, case insensitive.
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	processVariableValueNotEqualsIgnoreCase(String name, String value) Only select executions which are part of a process that have a local string variable which is not the given value, case insensitive.
void	setEventSubscriptions(List<EventSubscriptionQueryValue> eventSubscriptions)
void	setInvolvedUser(String involvedUser)
void	setSuspensionState(SuspensionState suspensionState)
ExecutionQuery	signalEventSubscription(String signalName)
ExecutionQuery	signalEventSubscriptionName(String signalName) Only select executions which have a signal event subscription for the given signal name.

Methods inherited from class org.activiti.engine.impl.AbstractVariableQueryImpl

ensureVariablesInitialized, getQueryVariableValues, variableValueEquals, variableValueEquals, variableValueEquals, variableValueEquals, variableValueEqualsIgnoreCase, variableValueEqualsIgnoreCase, variableValueGreaterThan, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThan, variableValueLessThanOrEqual, variableValueLessThanOrEqual, variableValueLike, variableValueLike, variableValueNotEquals, variableValueNotEquals, variableValueNotEqualsIgnoreCase, variableValueNotEqualsIgnoreCase

Methods inherited from class org.activiti.engine.impl.AbstractQuery

addOrder, asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, getOrderBy, list, listPage, orderBy, setCommandExecutor, singleResult

Methods inherited from class org.activiti.engine.impl.db.ListQueryParameterObject

getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getParameter, setDatabaseType, setFirstResult, setMaxResults, setParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.activiti.engine.runtime.ExecutionQuery

variableValueEquals, variableValueEquals, variableValueEqualsIgnoreCase, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals, variableValueNotEqualsIgnoreCase

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

asc, count, desc, list, listPage, singleResult

Field Detail

processDefinitionId

protected String processDefinitionId

processDefinitionKey

protected String processDefinitionKey

processDefinitionName

protected String processDefinitionName

activityId

protected String activityId

executionId

protected String executionId

parentId

protected String parentId

processInstanceId

protected String processInstanceId

eventSubscriptions

protected List<EventSubscriptionQueryValue> eventSubscriptions

superProcessInstanceId

protected String superProcessInstanceId

subProcessInstanceId

protected String subProcessInstanceId

excludeSubprocesses

protected boolean excludeSubprocesses

suspensionState

protected SuspensionState suspensionState

businessKey

protected String businessKey

includeChildExecutionsWithBusinessKeyQuery

protected boolean includeChildExecutionsWithBusinessKeyQuery

isActive

protected boolean isActive

involvedUser

protected String involvedUser

Constructor Detail

ExecutionQueryImpl

public ExecutionQueryImpl()

ExecutionQueryImpl

public ExecutionQueryImpl(CommandContext commandContext)

ExecutionQueryImpl

public ExecutionQueryImpl(CommandExecutor commandExecutor)

Method Detail

isProcessInstancesOnly

public boolean isProcessInstancesOnly()

processDefinitionId

public ExecutionQueryImpl processDefinitionId(String processDefinitionId)

Description copied from interface: ExecutionQuery

Only select executions which have the given process definition id.

Specified by:

processDefinitionId in interface ExecutionQuery

processDefinitionKey

public ExecutionQueryImpl processDefinitionKey(String processDefinitionKey)

Description copied from interface: ExecutionQuery

Only select executions which have the given process definition key.

Specified by:

processDefinitionKey in interface ExecutionQuery

processDefinitionName

public ExecutionQuery processDefinitionName(String processDefinitionName)

Description copied from interface: ExecutionQuery

Only select executions which have the given process definition name.

Specified by:

processDefinitionName in interface ExecutionQuery

processInstanceId

public ExecutionQueryImpl processInstanceId(String processInstanceId)

Description copied from interface: ExecutionQuery

Only select executions which have the given process instance id.

Specified by:

processInstanceId in interface ExecutionQuery

processInstanceBusinessKey

public ExecutionQuery processInstanceBusinessKey(String businessKey)

Description copied from interface: ExecutionQuery

Only executions with the given business key. Note that only process instances have a business key and as such, child executions will NOT be returned. If you want to return child executions of the process instance with the given business key too, use the ExecutionQuery.processInstanceBusinessKey(String, boolean) method with a boolean value of true instead.

Specified by:

processInstanceBusinessKey in interface ExecutionQuery

processInstanceBusinessKey

public ExecutionQuery processInstanceBusinessKey(String processInstanceBusinessKey,
                                        boolean includeChildExecutions)

Description copied from interface: ExecutionQuery

Only executions with the given business key. Similar to ExecutionQuery.processInstanceBusinessKey(String), but allows to choose whether child executions are returned or not.

Specified by:

processInstanceBusinessKey in interface ExecutionQuery

executionId

public ExecutionQueryImpl executionId(String executionId)

Description copied from interface: ExecutionQuery

Only select executions with the given id.

Specified by:

executionId in interface ExecutionQuery

activityId

public ExecutionQueryImpl activityId(String activityId)

Description copied from interface: ExecutionQuery

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

Specified by:

activityId in interface ExecutionQuery

parentId

public ExecutionQueryImpl parentId(String parentId)

Description copied from interface: ExecutionQuery

Only select executions which are a direct child-execution of the execution with the given id.

Specified by:

parentId in interface ExecutionQuery

signalEventSubscription

public ExecutionQuery signalEventSubscription(String signalName)

Specified by:

signalEventSubscription in interface ExecutionQuery

See Also:

ExecutionQuery.signalEventSubscriptionName(String)

signalEventSubscriptionName

public ExecutionQuery signalEventSubscriptionName(String signalName)

Description copied from interface: ExecutionQuery

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

Specified by:

signalEventSubscriptionName in interface ExecutionQuery

Parameters:

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

messageEventSubscriptionName

public ExecutionQuery messageEventSubscriptionName(String messageName)

Description copied from interface: ExecutionQuery

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

Specified by:

messageEventSubscriptionName in interface ExecutionQuery

Parameters:

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

eventSubscription

public ExecutionQuery eventSubscription(String eventType,
                               String eventName)

processVariableValueEquals

public ExecutionQuery processVariableValueEquals(String variableName,
                                        Object variableValue)

Description copied from interface: ExecutionQuery

Only select executions which are part of a process that have a variable with the given name set to the given value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

processVariableValueEquals in interface ExecutionQuery

processVariableValueEquals

public ExecutionQuery processVariableValueEquals(Object variableValue)

Description copied from interface: ExecutionQuery

Only select executions which are part of a process that have at least one variable with the given value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

processVariableValueEquals in interface ExecutionQuery

processVariableValueNotEquals

public ExecutionQuery processVariableValueNotEquals(String variableName,
                                           Object variableValue)

Description copied from interface: ExecutionQuery

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.

Specified by:

processVariableValueNotEquals in interface ExecutionQuery

processVariableValueEqualsIgnoreCase

public ExecutionQuery processVariableValueEqualsIgnoreCase(String name,
                                                  String value)

Description copied from interface: ExecutionQuery

Only select executions which are part of a process that have a local string variable with the given value, case insensitive.

This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).

Specified by:

processVariableValueEqualsIgnoreCase in interface ExecutionQuery

Parameters:

name - name of the variable, cannot be null.

value - value of the variable, cannot be null.

processVariableValueNotEqualsIgnoreCase

public ExecutionQuery processVariableValueNotEqualsIgnoreCase(String name,
                                                     String value)

Description copied from interface: ExecutionQuery

Only select executions which are part of a process that have a local string variable which is not the given value, case insensitive.

This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).

Specified by:

processVariableValueNotEqualsIgnoreCase in interface ExecutionQuery

Parameters:

name - name of the variable, cannot be null.

value - value of the variable, cannot be null.

orderByProcessInstanceId

public ExecutionQueryImpl orderByProcessInstanceId()

Description copied from interface: ExecutionQuery

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

Specified by:

orderByProcessInstanceId in interface ExecutionQuery

orderByProcessDefinitionId

public ExecutionQueryImpl orderByProcessDefinitionId()

Description copied from interface: ExecutionQuery

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

Specified by:

orderByProcessDefinitionId in interface ExecutionQuery

orderByProcessDefinitionKey

public ExecutionQueryImpl orderByProcessDefinitionKey()

Description copied from interface: ExecutionQuery

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

Specified by:

orderByProcessDefinitionKey in interface ExecutionQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractVariableQueryImpl<ExecutionQuery,Execution>

executeList

public List<Execution> executeList(CommandContext commandContext,
                          Page page)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractVariableQueryImpl<ExecutionQuery,Execution>

page - used if the results must be paged. If null, no paging will be applied.

getOnlyProcessInstances

public boolean getOnlyProcessInstances()

getProcessDefinitionKey

public String getProcessDefinitionKey()

getProcessDefinitionId

public String getProcessDefinitionId()

getProcessDefinitionName

public String getProcessDefinitionName()

getActivityId

public String getActivityId()

getProcessInstanceId

public String getProcessInstanceId()

getProcessInstanceIds

public String getProcessInstanceIds()

getBusinessKey

public String getBusinessKey()

getExecutionId

public String getExecutionId()

getSuperProcessInstanceId

public String getSuperProcessInstanceId()

getSubProcessInstanceId

public String getSubProcessInstanceId()

isExcludeSubprocesses

public boolean isExcludeSubprocesses()

getSuspensionState

public SuspensionState getSuspensionState()

setSuspensionState

public void setSuspensionState(SuspensionState suspensionState)

getEventSubscriptions

public List<EventSubscriptionQueryValue> getEventSubscriptions()

isIncludeChildExecutionsWithBusinessKeyQuery

public boolean isIncludeChildExecutionsWithBusinessKeyQuery()

setEventSubscriptions

public void setEventSubscriptions(List<EventSubscriptionQueryValue> eventSubscriptions)

isActive

public boolean isActive()

getInvolvedUser

public String getInvolvedUser()

setInvolvedUser

public void setInvolvedUser(String involvedUser)

getParentId

public String getParentId()