Package org.camunda.bpm.engine.impl
Class ExecutionQueryImpl
java.lang.Object
org.camunda.bpm.engine.impl.db.ListQueryParameterObject
org.camunda.bpm.engine.impl.AbstractQuery<T,U>
org.camunda.bpm.engine.impl.AbstractVariableQueryImpl<ExecutionQuery,Execution>
org.camunda.bpm.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:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery
AbstractQuery.ResultType
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected String
protected List<EventSubscriptionQueryValue>
protected String
protected String
protected String
protected String
protected String
protected boolean
protected String
protected String
protected String
protected SuspensionState
protected String[]
Fields inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl
queryVariableValues, variableNamesIgnoreCase, variableValuesIgnoreCase
Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery
commandExecutor, expressions, maxResultsLimitEnabled, resultType, SORTORDER_ASC, SORTORDER_DESC, validators
Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject
authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionactive()
Only selects executions which are active (i.e.activityId
(String activityId) Only select executions which contain an activity with the given id.eventSubscription
(EventType eventType, String eventName) long
executeCount
(CommandContext commandContext) executeList
(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.executionId
(String executionId) Only select executions with the given id.incidentId
(String incidentId) Only selects executions with the given incident id.incidentMessage
(String incidentMessage) Only selects executions with the given incident message.incidentMessageLike
(String incidentMessageLike) Only selects executions with an incident message like the given.incidentType
(String incidentType) Only selects executions with the given incident type.Only select executions that have a message event subscription.messageEventSubscriptionName
(String messageName) Only select executions which have a message event subscription for the given messageName.Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).Order by id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).processDefinitionId
(String processDefinitionId) Only select executions which have the given process definition id.processDefinitionKey
(String processDefinitionKey) Only select executions which have the given process definition key.processInstanceBusinessKey
(String businessKey) Only select executions that belong to a process instance with the given business keyprocessInstanceId
(String processInstanceId) Only select executions which have the given process instance id.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
(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.void
setEventSubscriptions
(List<EventSubscriptionQueryValue> eventSubscriptions) void
setSuspensionState
(SuspensionState suspensionState) signalEventSubscription
(String signalName) signalEventSubscriptionName
(String signalName) Only select executions which have a signal event subscription for the given signal name.Only selects executions which are suspended, because their process instance is suspended.tenantIdIn
(String... tenantIds) Only selects executions with one of the given tenant ids.Only selects executions which have no tenant id.Methods inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl
addVariable, createQueryVariableValue, ensureVariablesInitialized, getQueryVariableValues, isVariableNamesIgnoreCase, isVariableValuesIgnoreCase, matchVariableNamesIgnoreCase, matchVariableValuesIgnoreCase, validateVariable, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals, variableValueNotLike
Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery
addExpression, addValidator, asc, checkMaxResultsLimit, checkQueryOk, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteDeploymentIdMappingsList, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeDeploymentIdMappingsList, executeIdsList, executeResult, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listDeploymentIdMappings, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unlimitedList, validate, validate
Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject
getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.camunda.bpm.engine.runtime.ExecutionQuery
matchVariableNamesIgnoreCase, matchVariableValuesIgnoreCase, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals
Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
Field Details
-
processDefinitionId
-
processDefinitionKey
-
businessKey
-
activityId
-
executionId
-
processInstanceId
-
eventSubscriptions
-
suspensionState
-
incidentType
-
incidentId
-
incidentMessage
-
incidentMessageLike
-
isTenantIdSet
protected boolean isTenantIdSet -
tenantIds
-
-
Constructor Details
-
ExecutionQueryImpl
public ExecutionQueryImpl() -
ExecutionQueryImpl
-
-
Method Details
-
processDefinitionId
Description copied from interface:ExecutionQuery
Only select executions which have the given process definition id.- Specified by:
processDefinitionId
in interfaceExecutionQuery
-
processDefinitionKey
Description copied from interface:ExecutionQuery
Only select executions which have the given process definition key.- Specified by:
processDefinitionKey
in interfaceExecutionQuery
-
processInstanceId
Description copied from interface:ExecutionQuery
Only select executions which have the given process instance id.- Specified by:
processInstanceId
in interfaceExecutionQuery
-
processInstanceBusinessKey
Description copied from interface:ExecutionQuery
Only select executions that belong to a process instance with the given business key- Specified by:
processInstanceBusinessKey
in interfaceExecutionQuery
-
executionId
Description copied from interface:ExecutionQuery
Only select executions with the given id.- Specified by:
executionId
in interfaceExecutionQuery
-
activityId
Description copied from interface:ExecutionQuery
Only select executions which contain an activity with the given id.- Specified by:
activityId
in interfaceExecutionQuery
-
signalEventSubscription
- Specified by:
signalEventSubscription
in interfaceExecutionQuery
- See Also:
-
signalEventSubscriptionName
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 interfaceExecutionQuery
- Parameters:
signalName
- the name of the signal the execution has subscribed to
-
messageEventSubscriptionName
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 interfaceExecutionQuery
- Parameters:
messageName
- the name of the message the execution has subscribed to
-
messageEventSubscription
Description copied from interface:ExecutionQuery
Only select executions that have a message event subscription. UseExecutionQuery.messageEventSubscriptionName(String)
to filter for executions with message event subscriptions with a certain name.- Specified by:
messageEventSubscription
in interfaceExecutionQuery
-
eventSubscription
-
suspended
Description copied from interface:ExecutionQuery
Only selects executions which are suspended, because their process instance is suspended.- Specified by:
suspended
in interfaceExecutionQuery
-
active
Description copied from interface:ExecutionQuery
Only selects executions which are active (i.e. not suspended).- Specified by:
active
in interfaceExecutionQuery
-
processVariableValueEquals
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.- Specified by:
processVariableValueEquals
in interfaceExecutionQuery
-
processVariableValueNotEquals
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 andSerializable
objects (which are not primitive type wrappers) are not supported.- Specified by:
processVariableValueNotEquals
in interfaceExecutionQuery
-
incidentType
Description copied from interface:ExecutionQuery
Only selects executions with the given incident type.- Specified by:
incidentType
in interfaceExecutionQuery
-
incidentId
Description copied from interface:ExecutionQuery
Only selects executions with the given incident id.- Specified by:
incidentId
in interfaceExecutionQuery
-
incidentMessage
Description copied from interface:ExecutionQuery
Only selects executions with the given incident message.- Specified by:
incidentMessage
in interfaceExecutionQuery
-
incidentMessageLike
Description copied from interface:ExecutionQuery
Only selects executions with an incident message like the given.- Specified by:
incidentMessageLike
in interfaceExecutionQuery
-
tenantIdIn
Description copied from interface:ExecutionQuery
Only selects executions with one of the given tenant ids.- Specified by:
tenantIdIn
in interfaceExecutionQuery
-
withoutTenantId
Description copied from interface:ExecutionQuery
Only selects executions which have no tenant id.- Specified by:
withoutTenantId
in interfaceExecutionQuery
-
orderByProcessInstanceId
Description copied from interface:ExecutionQuery
Order by id (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessInstanceId
in interfaceExecutionQuery
-
orderByProcessDefinitionId
Description copied from interface:ExecutionQuery
Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessDefinitionId
in interfaceExecutionQuery
-
orderByProcessDefinitionKey
Description copied from interface:ExecutionQuery
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessDefinitionKey
in interfaceExecutionQuery
-
orderByTenantId
Description copied from interface:ExecutionQuery
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). Note that the ordering of executions without tenant id is database-specific.- Specified by:
orderByTenantId
in interfaceExecutionQuery
-
executeCount
- Specified by:
executeCount
in classAbstractVariableQueryImpl<ExecutionQuery,
Execution>
-
executeList
Description copied from class:AbstractQuery
Executes the actual query to retrieve the list of results.- Specified by:
executeList
in classAbstractVariableQueryImpl<ExecutionQuery,
Execution> page
- used if the results must be paged. If null, no paging will be applied.
-
getProcessDefinitionKey
-
getProcessDefinitionId
-
getActivityId
-
getProcessInstanceId
-
getProcessInstanceIds
-
getBusinessKey
-
getExecutionId
-
getSuspensionState
-
setSuspensionState
-
getEventSubscriptions
-
setEventSubscriptions
-
getIncidentId
-
getIncidentType
-
getIncidentMessage
-
getIncidentMessageLike
-