Package org.flowable.engine.impl
Class ProcessInstanceQueryImpl
java.lang.Object
org.flowable.common.engine.impl.db.ListQueryParameterObject
org.flowable.common.engine.impl.query.AbstractQuery<T,U>
org.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
org.flowable.engine.impl.ProcessInstanceQueryImpl
- All Implemented Interfaces:
Serializable
,org.flowable.common.engine.api.query.CacheAwareQuery<org.flowable.engine.impl.persistence.entity.ExecutionEntity>
,org.flowable.common.engine.api.query.Query<ProcessInstanceQuery,
,ProcessInstance> org.flowable.common.engine.impl.interceptor.Command<Object>
,ProcessInstanceQuery
public class ProcessInstanceQueryImpl
extends org.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
implements ProcessInstanceQuery, org.flowable.common.engine.api.query.CacheAwareQuery<org.flowable.engine.impl.persistence.entity.ExecutionEntity>, Serializable
- Author:
- Tom Baeyens, Joram Barrez, Tijs Rademakers, Frederik Heremans, Falko Menge, Daniel Meyer
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
org.flowable.common.engine.impl.db.ListQueryParameterObject.OrderBy, org.flowable.common.engine.impl.db.ListQueryParameterObject.ResultType
Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
org.flowable.common.engine.api.query.Query.NullHandlingOnOrder
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected ProcessInstanceQueryImpl
protected String
protected List<org.flowable.eventsubscription.service.impl.EventSubscriptionQueryValue>
protected boolean
protected String
protected boolean
protected boolean
protected boolean
protected IdentityLinkQueryObject
protected String
protected IdentityLinkQueryObject
protected String
protected String
protected String
protected String
protected boolean
protected boolean
protected boolean
protected List<ProcessInstanceQueryImpl>
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected Integer
protected org.flowable.engine.impl.cfg.ProcessEngineConfigurationImpl
protected String
protected String
protected String
protected String
protected Date
protected Date
protected String
protected String
protected String
protected org.flowable.common.engine.impl.db.SuspensionState
protected String
protected String
protected String
protected boolean
protected boolean
protected boolean
Fields inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl
queryVariableValues, variableValueProvider
Fields inherited from class org.flowable.common.engine.impl.query.AbstractQuery
commandContext, commandExecutor
Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
databaseType, DEFAULT_ORDER_BY, defaultOrderBy, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC
-
Constructor Summary
ConstructorDescriptionProcessInstanceQueryImpl
(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, org.flowable.engine.impl.cfg.ProcessEngineConfigurationImpl processEngineConfiguration) ProcessInstanceQueryImpl
(org.flowable.common.engine.impl.interceptor.CommandExecutor commandExecutor, org.flowable.engine.impl.cfg.ProcessEngineConfigurationImpl processEngineConfiguration) -
Method Summary
Modifier and TypeMethodDescriptionactive()
Only select process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.activeActivityId
(String activityId) Select the process instances which have an active activity instance like the provided id.activeActivityIds
(Set<String> activityIds) Select the process instances which have an active activity instance like the provided ids.deploymentId
(String deploymentId) Select the process instances which are defined by a deployment with the given id.deploymentIdIn
(List<String> deploymentIds) Select the process instances which are defined by one of the given deployment idsendOr()
End an OR statement.void
enhanceCachedValue
(org.flowable.engine.impl.persistence.entity.ExecutionEntity processInstance) protected void
excludeSubprocesses
(boolean excludeSubprocesses) Exclude sub processes from the query result;long
executeCount
(org.flowable.common.engine.impl.interceptor.CommandContext commandContext) executeList
(org.flowable.common.engine.impl.interceptor.CommandContext commandContext) List<org.flowable.eventsubscription.service.impl.EventSubscriptionQueryValue>
getId()
getName()
boolean
Methods needed for ibatis because of re-use of query-xml for executions.org.flowable.common.engine.impl.db.SuspensionState
Include process variables in the process query resultinvolvedGroup
(String groupId, String identityLinkType) Select the process instances with which the group with the given id and identity link type is involved.involvedGroups
(Set<String> involvedGroups) Select the process instances with which theGroup
s with the given ids are involved.involvedUser
(String involvedUser) Select the process instances with which the user with the given id is involved.involvedUser
(String userId, String identityLinkType) Select the process instances with which the user with the given id and identity link type is involved.boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
Localize process name and description to specified locale.or()
Begin an OR statement.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 start time (needs to be followed byQuery.asc()
orQuery.desc()
).Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).processDefinitionCategory
(String processDefinitionCategory) Only select process instances whose process definition category is processDefinitionCategory.processDefinitionCategoryLike
(String processDefinitionCategoryLike) Only select process instances whose process definition category is like the given value.processDefinitionCategoryLikeIgnoreCase
(String processDefinitionCategoryLikeIgnoreCase) Only select process instances whose process definition category is like the given value, ignoring upper/lower case.processDefinitionEngineVersion
(String processDefinitionEngineVersion) Select the process instances which are defined by a process definition with the given engine version.processDefinitionId
(String processDefinitionId) Select the process instances which are defined by a process definition with the given id.processDefinitionIds
(Set<String> processDefinitionIds) Select the process instances which are defined by process definitions with the given ids.processDefinitionKey
(String processDefinitionKey) Select the process instances which are defined by a process definition with the given key.processDefinitionKeyLike
(String processDefinitionKeyLike) Select process instances whose process definition key is like the given valueprocessDefinitionKeyLikeIgnoreCase
(String processDefinitionKeyLikeIgnoreCase) Select process instances whose process definition key is like the given value, ignoring upper/lower case.processDefinitionKeys
(Set<String> processDefinitionKeys) Select the process instances which are defined by process definitions with the given keys.processDefinitionName
(String processDefinitionName) Select process instances whose process definition name is processDefinitionNameprocessDefinitionNameLike
(String processDefinitionNameLike) Select process instances whose process definition name is like the given valueprocessDefinitionNameLikeIgnoreCase
(String processDefinitionNameLikeIgnoreCase) Select process instances whose process definition name is like the given value, ignoring upper/lower case.processDefinitionVersion
(Integer processDefinitionVersion) Only select process instances with a certain process definition version.processInstanceBusinessKey
(String businessKey) Select process instances with the given business keyprocessInstanceBusinessKey
(String businessKey, String processDefinitionKey) Select process instance with the given business key, unique for the given process definitionprocessInstanceBusinessKeyLike
(String businessKeyLike) Select process instances with a business key like the given value.processInstanceBusinessKeyLikeIgnoreCase
(String businessKeyLikeIgnoreCase) Select process instances with a business key like the given value, ignoring upper/lower case.processInstanceBusinessStatus
(String businessStatus) Select process instances with the given business statusprocessInstanceBusinessStatusLike
(String businessStatusLike) Select process instances with a business status like the given value.processInstanceBusinessStatusLikeIgnoreCase
(String businessStatusLikeIgnoreCase) Select process instances with a business status like the given value, ignoring upper/lower case.processInstanceCallbackId
(String callbackId) Only select process instances with the given callback id.processInstanceCallbackType
(String callbackType) Only select process instances with the given callback type.processInstanceId
(String processInstanceId) Select the process instance with the given idprocessInstanceIds
(Set<String> processInstanceIds) Select process instances whose id is in the given set of idsprocessInstanceName
(String name) Only select process instances with the given name.processInstanceNameLike
(String nameLike) Only select process instances with a name like the given value.processInstanceNameLikeIgnoreCase
(String nameLikeIgnoreCase) Only select process instances with a name like the given value, ignoring upper/lower case.processInstanceParentScopeId
(String parentId) Only select process instances with the given parent process instance id.processInstanceReferenceId
(String referenceId) Only select process instances with the given reference id.processInstanceReferenceType
(String referenceType) Only select process instances with the given callback type.processInstanceRootScopeId
(String rootId) Only select process instances with a root instance with a name like the given value.processInstanceTenantId
(String tenantId) Only select process instances that have the given tenant id.processInstanceTenantIdLike
(String tenantIdLike) Only select process instances with a tenant id like the given one.processInstanceTenantIdLikeIgnoreCase
(String tenantIdLikeIgnoreCase) Only select process instances with a tenant id like the given one, ignoring upper/lower case.Only select process instances that do not have a tenant id.void
setEventSubscriptions
(List<org.flowable.eventsubscription.service.impl.EventSubscriptionQueryValue> eventSubscriptions) void
void
setNameLike
(String nameLike) void
setSafeInvolvedGroups
(List<List<String>> safeInvolvedGroups) void
setStartedAfter
(Date startedAfter) void
setStartedBefore
(Date startedBefore) void
setStartedBy
(String startedBy) void
setSuspensionState
(org.flowable.common.engine.impl.db.SuspensionState suspensionState) startedAfter
(Date afterTime) Only select process instances started after the given timestartedBefore
(Date beforeTime) Only select process instances started before the given timeOnly select process instances started by the given user idsubProcessInstanceId
(String subProcessInstanceId) Select the process instance that have as sub process instance the given process instance.superProcessInstanceId
(String superProcessInstanceId) Select the process instances which are a sub process instance of the given super process instance.Only select process instances which are suspended, either because the process instance itself is suspended or because the corresponding process definition is suspendedvariableExists
(String name) Only select process instances which have a variable with the given name.variableNotExists
(String name) Only select process instances which does not have a variable with the given name.variableValueEquals
(Object variableValue) Only select process instances which have at least one global variable with the given value.variableValueEquals
(String variableName, Object variableValue) Only select process instances which have a global variable with the given value.variableValueEqualsIgnoreCase
(String name, String value) Only select process instances which have a local string variable with the given value, case insensitive.variableValueGreaterThan
(String name, Object value) Only select process instances which have a variable value greater than the passed value.variableValueGreaterThanOrEqual
(String name, Object value) Only select process instances which have a global variable value greater than or equal to the passed value.variableValueLessThan
(String name, Object value) Only select process instances which have a global variable value less than the passed value.variableValueLessThanOrEqual
(String name, Object value) Only select process instances which have a global variable value less than or equal to the passed value.variableValueLike
(String name, String value) Only select process instances which have a global variable value like the given value.variableValueLikeIgnoreCase
(String name, String value) Only select process instances which have a global variable value like the given value (case insensitive).variableValueNotEquals
(String variableName, Object variableValue) Only select process instances which have a global variable with the given name, but with a different value than the passed value.variableValueNotEqualsIgnoreCase
(String name, String value) Only select process instances which have a local string variable which is not the given value, case insensitive.Only select process instances that failed due to an exception happening during a job execution.Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.Methods inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl
addVariable, addVariable, getQueryVariableValues, hasLocalQueryVariableValue, hasNonLocalQueryVariableValue, hasValueComparisonQueryVariables, isBoolean, scopedVariableExists, scopedVariableNotExists, scopedVariableValueEquals, scopedVariableValueEquals, scopedVariableValueEqualsIgnoreCase, scopedVariableValueGreaterThan, scopedVariableValueGreaterThanOrEqual, scopedVariableValueLessThan, scopedVariableValueLessThanOrEqual, scopedVariableValueLike, scopedVariableValueLikeIgnoreCase, scopedVariableValueNotEquals, scopedVariableValueNotEqualsIgnoreCase, variableExists, variableNotExists, variableValueEquals, variableValueEquals, variableValueEqualsIgnoreCase, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueLikeIgnoreCase, variableValueNotEquals, variableValueNotEqualsIgnoreCase
Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery
asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, list, listPage, orderBy, orderBy, setCommandExecutor, singleResult
Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
addOrder, buildOrderBy, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getNullHandlingColumn, getOrderBy, getOrderByCollectionSafe, getOrderByForWindow, getOuterJoinOrderBy, getParameter, hasOrderBy, hasOrderByForColumn, isNeedsPaging, mapOrderByToSql, setDatabaseType, setFirstResult, setMaxResults, setNullHandlingColumn, setParameter
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.flowable.common.engine.api.query.Query
asc, count, desc, list, listPage, orderBy, orderBy, singleResult
-
Field Details
-
processEngineConfiguration
protected org.flowable.engine.impl.cfg.ProcessEngineConfigurationImpl processEngineConfiguration -
executionId
-
businessKey
-
businessKeyLike
-
businessKeyLikeIgnoreCase
-
includeChildExecutionsWithBusinessKeyQuery
protected boolean includeChildExecutionsWithBusinessKeyQuery -
businessStatus
-
businessStatusLike
-
businessStatusLikeIgnoreCase
-
processDefinitionId
-
processDefinitionIds
-
processDefinitionCategory
-
processDefinitionCategoryLike
-
processDefinitionCategoryLikeIgnoreCase
-
processDefinitionName
-
processDefinitionNameLike
-
processDefinitionNameLikeIgnoreCase
-
processDefinitionVersion
-
processInstanceIds
-
processDefinitionKey
-
processDefinitionKeyLike
-
processDefinitionKeyLikeIgnoreCase
-
processDefinitionKeys
-
processDefinitionEngineVersion
-
deploymentId
-
deploymentIds
-
superProcessInstanceId
-
subProcessInstanceId
-
excludeSubprocesses
protected boolean excludeSubprocesses -
involvedUser
-
involvedUserIdentityLink
-
involvedGroups
-
involvedGroupIdentityLink
-
suspensionState
protected org.flowable.common.engine.impl.db.SuspensionState suspensionState -
includeProcessVariables
protected boolean includeProcessVariables -
withJobException
protected boolean withJobException -
name
-
nameLike
-
nameLikeIgnoreCase
-
rootScopeId
-
parentScopeId
-
activeActivityId
-
activeActivityIds
-
callbackId
-
callbackType
-
referenceId
-
referenceType
-
locale
-
withLocalizationFallback
protected boolean withLocalizationFallback -
tenantId
-
tenantIdLike
-
tenantIdLikeIgnoreCase
-
withoutTenantId
protected boolean withoutTenantId -
orQueryObjects
-
currentOrQueryObject
-
inOrStatement
protected boolean inOrStatement -
startedBefore
-
startedAfter
-
startedBy
-
activityId
-
eventSubscriptions
protected List<org.flowable.eventsubscription.service.impl.EventSubscriptionQueryValue> eventSubscriptions -
onlyChildExecutions
protected boolean onlyChildExecutions -
onlyProcessInstanceExecutions
protected boolean onlyProcessInstanceExecutions -
onlySubProcessExecutions
protected boolean onlySubProcessExecutions -
rootProcessInstanceId
-
-
Constructor Details
-
ProcessInstanceQueryImpl
public ProcessInstanceQueryImpl() -
ProcessInstanceQueryImpl
public ProcessInstanceQueryImpl(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, org.flowable.engine.impl.cfg.ProcessEngineConfigurationImpl processEngineConfiguration) -
ProcessInstanceQueryImpl
public ProcessInstanceQueryImpl(org.flowable.common.engine.impl.interceptor.CommandExecutor commandExecutor, org.flowable.engine.impl.cfg.ProcessEngineConfigurationImpl processEngineConfiguration)
-
-
Method Details
-
processInstanceId
Description copied from interface:ProcessInstanceQuery
Select the process instance with the given id- Specified by:
processInstanceId
in interfaceProcessInstanceQuery
-
processInstanceIds
Description copied from interface:ProcessInstanceQuery
Select process instances whose id is in the given set of ids- Specified by:
processInstanceIds
in interfaceProcessInstanceQuery
-
processInstanceBusinessKey
Description copied from interface:ProcessInstanceQuery
Select process instances with the given business key- Specified by:
processInstanceBusinessKey
in interfaceProcessInstanceQuery
-
processInstanceBusinessKey
public ProcessInstanceQuery processInstanceBusinessKey(String businessKey, String processDefinitionKey) Description copied from interface:ProcessInstanceQuery
Select process instance with the given business key, unique for the given process definition- Specified by:
processInstanceBusinessKey
in interfaceProcessInstanceQuery
-
processInstanceBusinessKeyLike
Description copied from interface:ProcessInstanceQuery
Select process instances with a business key like the given value.- Specified by:
processInstanceBusinessKeyLike
in interfaceProcessInstanceQuery
-
processInstanceBusinessKeyLikeIgnoreCase
public ProcessInstanceQuery processInstanceBusinessKeyLikeIgnoreCase(String businessKeyLikeIgnoreCase) Description copied from interface:ProcessInstanceQuery
Select process instances with a business key like the given value, ignoring upper/lower case.- Specified by:
processInstanceBusinessKeyLikeIgnoreCase
in interfaceProcessInstanceQuery
-
processInstanceBusinessStatus
Description copied from interface:ProcessInstanceQuery
Select process instances with the given business status- Specified by:
processInstanceBusinessStatus
in interfaceProcessInstanceQuery
-
processInstanceBusinessStatusLike
Description copied from interface:ProcessInstanceQuery
Select process instances with a business status like the given value.- Specified by:
processInstanceBusinessStatusLike
in interfaceProcessInstanceQuery
-
processInstanceBusinessStatusLikeIgnoreCase
public ProcessInstanceQuery processInstanceBusinessStatusLikeIgnoreCase(String businessStatusLikeIgnoreCase) Description copied from interface:ProcessInstanceQuery
Select process instances with a business status like the given value, ignoring upper/lower case.- Specified by:
processInstanceBusinessStatusLikeIgnoreCase
in interfaceProcessInstanceQuery
-
processInstanceTenantId
Description copied from interface:ProcessInstanceQuery
Only select process instances that have the given tenant id.- Specified by:
processInstanceTenantId
in interfaceProcessInstanceQuery
-
processInstanceTenantIdLike
Description copied from interface:ProcessInstanceQuery
Only select process instances with a tenant id like the given one.- Specified by:
processInstanceTenantIdLike
in interfaceProcessInstanceQuery
-
processInstanceTenantIdLikeIgnoreCase
Description copied from interface:ProcessInstanceQuery
Only select process instances with a tenant id like the given one, ignoring upper/lower case.- Specified by:
processInstanceTenantIdLikeIgnoreCase
in interfaceProcessInstanceQuery
-
processInstanceWithoutTenantId
Description copied from interface:ProcessInstanceQuery
Only select process instances that do not have a tenant id.- Specified by:
processInstanceWithoutTenantId
in interfaceProcessInstanceQuery
-
processDefinitionCategory
Description copied from interface:ProcessInstanceQuery
Only select process instances whose process definition category is processDefinitionCategory.- Specified by:
processDefinitionCategory
in interfaceProcessInstanceQuery
-
processDefinitionCategoryLike
Description copied from interface:ProcessInstanceQuery
Only select process instances whose process definition category is like the given value.- Specified by:
processDefinitionCategoryLike
in interfaceProcessInstanceQuery
-
processDefinitionCategoryLikeIgnoreCase
public ProcessInstanceQuery processDefinitionCategoryLikeIgnoreCase(String processDefinitionCategoryLikeIgnoreCase) Description copied from interface:ProcessInstanceQuery
Only select process instances whose process definition category is like the given value, ignoring upper/lower case.- Specified by:
processDefinitionCategoryLikeIgnoreCase
in interfaceProcessInstanceQuery
-
processDefinitionName
Description copied from interface:ProcessInstanceQuery
Select process instances whose process definition name is processDefinitionName- Specified by:
processDefinitionName
in interfaceProcessInstanceQuery
-
processDefinitionNameLike
Description copied from interface:ProcessInstanceQuery
Select process instances whose process definition name is like the given value- Specified by:
processDefinitionNameLike
in interfaceProcessInstanceQuery
-
processDefinitionNameLikeIgnoreCase
public ProcessInstanceQuery processDefinitionNameLikeIgnoreCase(String processDefinitionNameLikeIgnoreCase) Description copied from interface:ProcessInstanceQuery
Select process instances whose process definition name is like the given value, ignoring upper/lower case.- Specified by:
processDefinitionNameLikeIgnoreCase
in interfaceProcessInstanceQuery
-
processDefinitionVersion
Description copied from interface:ProcessInstanceQuery
Only select process instances with a certain process definition version. Particularly useful when used in combination withProcessInstanceQuery.processDefinitionKey(String)
- Specified by:
processDefinitionVersion
in interfaceProcessInstanceQuery
-
processDefinitionId
Description copied from interface:ProcessInstanceQuery
Select the process instances which are defined by a process definition with the given id.- Specified by:
processDefinitionId
in interfaceProcessInstanceQuery
-
processDefinitionIds
Description copied from interface:ProcessInstanceQuery
Select the process instances which are defined by process definitions with the given ids.- Specified by:
processDefinitionIds
in interfaceProcessInstanceQuery
-
processDefinitionKey
Description copied from interface:ProcessInstanceQuery
Select the process instances which are defined by a process definition with the given key.- Specified by:
processDefinitionKey
in interfaceProcessInstanceQuery
-
processDefinitionKeyLike
Description copied from interface:ProcessInstanceQuery
Select process instances whose process definition key is like the given value- Specified by:
processDefinitionKeyLike
in interfaceProcessInstanceQuery
-
processDefinitionKeyLikeIgnoreCase
public ProcessInstanceQueryImpl processDefinitionKeyLikeIgnoreCase(String processDefinitionKeyLikeIgnoreCase) Description copied from interface:ProcessInstanceQuery
Select process instances whose process definition key is like the given value, ignoring upper/lower case.- Specified by:
processDefinitionKeyLikeIgnoreCase
in interfaceProcessInstanceQuery
-
processDefinitionKeys
Description copied from interface:ProcessInstanceQuery
Select the process instances which are defined by process definitions with the given keys.- Specified by:
processDefinitionKeys
in interfaceProcessInstanceQuery
-
processDefinitionEngineVersion
Description copied from interface:ProcessInstanceQuery
Select the process instances which are defined by a process definition with the given engine version.- Specified by:
processDefinitionEngineVersion
in interfaceProcessInstanceQuery
-
deploymentId
Description copied from interface:ProcessInstanceQuery
Select the process instances which are defined by a deployment with the given id.- Specified by:
deploymentId
in interfaceProcessInstanceQuery
-
deploymentIdIn
Description copied from interface:ProcessInstanceQuery
Select the process instances which are defined by one of the given deployment ids- Specified by:
deploymentIdIn
in interfaceProcessInstanceQuery
-
superProcessInstanceId
Description copied from interface:ProcessInstanceQuery
Select the process instances which are a sub process instance of the given super process instance.- Specified by:
superProcessInstanceId
in interfaceProcessInstanceQuery
-
subProcessInstanceId
Description copied from interface:ProcessInstanceQuery
Select the process instance that have as sub process instance the given process instance. Note that there will always be maximum only one such process instance that can be the result of this query.- Specified by:
subProcessInstanceId
in interfaceProcessInstanceQuery
-
excludeSubprocesses
Description copied from interface:ProcessInstanceQuery
Exclude sub processes from the query result;- Specified by:
excludeSubprocesses
in interfaceProcessInstanceQuery
-
involvedUser
Description copied from interface:ProcessInstanceQuery
Select the process instances with which the user with the given id is involved.- Specified by:
involvedUser
in interfaceProcessInstanceQuery
-
involvedUser
Description copied from interface:ProcessInstanceQuery
Select the process instances with which the user with the given id and identity link type is involved.- Specified by:
involvedUser
in interfaceProcessInstanceQuery
-
involvedGroup
Description copied from interface:ProcessInstanceQuery
Select the process instances with which the group with the given id and identity link type is involved.- Specified by:
involvedGroup
in interfaceProcessInstanceQuery
-
involvedGroups
Description copied from interface:ProcessInstanceQuery
Select the process instances with which theGroup
s with the given ids are involved.- Specified by:
involvedGroups
in interfaceProcessInstanceQuery
-
active
Description copied from interface:ProcessInstanceQuery
Only select process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.- Specified by:
active
in interfaceProcessInstanceQuery
-
suspended
Description copied from interface:ProcessInstanceQuery
Only select process instances which are suspended, either because the process instance itself is suspended or because the corresponding process definition is suspended- Specified by:
suspended
in interfaceProcessInstanceQuery
-
includeProcessVariables
Description copied from interface:ProcessInstanceQuery
Include process variables in the process query result- Specified by:
includeProcessVariables
in interfaceProcessInstanceQuery
-
withJobException
Description copied from interface:ProcessInstanceQuery
Only select process instances that failed due to an exception happening during a job execution.- Specified by:
withJobException
in interfaceProcessInstanceQuery
-
processInstanceName
Description copied from interface:ProcessInstanceQuery
Only select process instances with the given name.- Specified by:
processInstanceName
in interfaceProcessInstanceQuery
-
processInstanceNameLike
Description copied from interface:ProcessInstanceQuery
Only select process instances with a name like the given value.- Specified by:
processInstanceNameLike
in interfaceProcessInstanceQuery
-
processInstanceNameLikeIgnoreCase
Description copied from interface:ProcessInstanceQuery
Only select process instances with a name like the given value, ignoring upper/lower case.- Specified by:
processInstanceNameLikeIgnoreCase
in interfaceProcessInstanceQuery
-
processInstanceRootScopeId
Description copied from interface:ProcessInstanceQuery
Only select process instances with a root instance with a name like the given value.- Specified by:
processInstanceRootScopeId
in interfaceProcessInstanceQuery
-
processInstanceParentScopeId
Description copied from interface:ProcessInstanceQuery
Only select process instances with the given parent process instance id.- Specified by:
processInstanceParentScopeId
in interfaceProcessInstanceQuery
-
activeActivityId
Description copied from interface:ProcessInstanceQuery
Select the process instances which have an active activity instance like the provided id.- Specified by:
activeActivityId
in interfaceProcessInstanceQuery
-
activeActivityIds
Description copied from interface:ProcessInstanceQuery
Select the process instances which have an active activity instance like the provided ids.- Specified by:
activeActivityIds
in interfaceProcessInstanceQuery
-
processInstanceCallbackId
Description copied from interface:ProcessInstanceQuery
Only select process instances with the given callback id.- Specified by:
processInstanceCallbackId
in interfaceProcessInstanceQuery
-
processInstanceCallbackType
Description copied from interface:ProcessInstanceQuery
Only select process instances with the given callback type.- Specified by:
processInstanceCallbackType
in interfaceProcessInstanceQuery
-
processInstanceReferenceId
Description copied from interface:ProcessInstanceQuery
Only select process instances with the given reference id.- Specified by:
processInstanceReferenceId
in interfaceProcessInstanceQuery
-
processInstanceReferenceType
Description copied from interface:ProcessInstanceQuery
Only select process instances with the given callback type.- Specified by:
processInstanceReferenceType
in interfaceProcessInstanceQuery
-
or
Description copied from interface:ProcessInstanceQuery
Begin an OR statement. Make sure you invoke the endOr method at the end of your OR statement. Only one OR statement is allowed, for the second call to this method an exception will be thrown.- Specified by:
or
in interfaceProcessInstanceQuery
-
endOr
Description copied from interface:ProcessInstanceQuery
End an OR statement. Only one OR statement is allowed, for the second call to this method an exception will be thrown.- Specified by:
endOr
in interfaceProcessInstanceQuery
-
variableValueEquals
Description copied from interface:ProcessInstanceQuery
Only select process instances which have a global variable with the given value. The type of variable is determined based on the value, using types configured inProcessEngineConfigurationImpl.getVariableTypes()
. Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueEquals
in interfaceProcessInstanceQuery
- Overrides:
variableValueEquals
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - Parameters:
variableName
- name of the variable, cannot be null.
-
variableValueNotEquals
Description copied from interface:ProcessInstanceQuery
Only select process instances which have a global 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:
variableValueNotEquals
in interfaceProcessInstanceQuery
- Overrides:
variableValueNotEquals
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - Parameters:
variableName
- name of the variable, cannot be null.
-
variableValueEquals
Description copied from interface:ProcessInstanceQuery
Only select process instances which have at least one global variable with the given value. The type of variable is determined based on the value, using types configured inProcessEngineConfigurationImpl.getVariableTypes()
. Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueEquals
in interfaceProcessInstanceQuery
- Overrides:
variableValueEquals
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance>
-
variableValueEqualsIgnoreCase
Description copied from interface:ProcessInstanceQuery
Only select process instances which 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:
variableValueEqualsIgnoreCase
in interfaceProcessInstanceQuery
- Overrides:
variableValueEqualsIgnoreCase
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - Parameters:
name
- name of the variable, cannot be null.value
- value of the variable, cannot be null.
-
variableValueNotEqualsIgnoreCase
Description copied from interface:ProcessInstanceQuery
Only select process instances which 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:
variableValueNotEqualsIgnoreCase
in interfaceProcessInstanceQuery
- Overrides:
variableValueNotEqualsIgnoreCase
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - Parameters:
name
- name of the variable, cannot be null.value
- value of the variable, cannot be null.
-
variableValueGreaterThan
Description copied from interface:ProcessInstanceQuery
Only select process instances which have a variable value greater than the passed value. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueGreaterThan
in interfaceProcessInstanceQuery
- Overrides:
variableValueGreaterThan
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - Parameters:
name
- variable name, cannot be null.value
- variable value, cannot be null.
-
variableValueGreaterThanOrEqual
Description copied from interface:ProcessInstanceQuery
Only select process instances which have a global variable value greater than or equal to the passed value. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueGreaterThanOrEqual
in interfaceProcessInstanceQuery
- Overrides:
variableValueGreaterThanOrEqual
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - Parameters:
name
- variable name, cannot be null.value
- variable value, cannot be null.
-
variableValueLessThan
Description copied from interface:ProcessInstanceQuery
Only select process instances which have a global variable value less than the passed value. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueLessThan
in interfaceProcessInstanceQuery
- Overrides:
variableValueLessThan
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - Parameters:
name
- variable name, cannot be null.value
- variable value, cannot be null.
-
variableValueLessThanOrEqual
Description copied from interface:ProcessInstanceQuery
Only select process instances which have a global variable value less than or equal to the passed value. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueLessThanOrEqual
in interfaceProcessInstanceQuery
- Overrides:
variableValueLessThanOrEqual
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - Parameters:
name
- variable name, cannot be null.value
- variable value, cannot be null.
-
variableValueLike
Description copied from interface:ProcessInstanceQuery
Only select process instances which have a global variable value like the given value. This be used on string variables only.- Specified by:
variableValueLike
in interfaceProcessInstanceQuery
- Overrides:
variableValueLike
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - 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%).
-
variableValueLikeIgnoreCase
Description copied from interface:ProcessInstanceQuery
Only select process instances which have a global variable value like the given value (case insensitive). This be used on string variables only.- Specified by:
variableValueLikeIgnoreCase
in interfaceProcessInstanceQuery
- Overrides:
variableValueLikeIgnoreCase
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - 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%).
-
variableExists
Description copied from interface:ProcessInstanceQuery
Only select process instances which have a variable with the given name.- Specified by:
variableExists
in interfaceProcessInstanceQuery
- Overrides:
variableExists
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - Parameters:
name
- cannot be null.
-
variableNotExists
Description copied from interface:ProcessInstanceQuery
Only select process instances which does not have a variable with the given name.- Specified by:
variableNotExists
in interfaceProcessInstanceQuery
- Overrides:
variableNotExists
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance> - Parameters:
name
- cannot be null.
-
locale
Description copied from interface:ProcessInstanceQuery
Localize process name and description to specified locale.- Specified by:
locale
in interfaceProcessInstanceQuery
-
withLocalizationFallback
Description copied from interface:ProcessInstanceQuery
Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.- Specified by:
withLocalizationFallback
in interfaceProcessInstanceQuery
-
startedBefore
Description copied from interface:ProcessInstanceQuery
Only select process instances started before the given time- Specified by:
startedBefore
in interfaceProcessInstanceQuery
-
startedAfter
Description copied from interface:ProcessInstanceQuery
Only select process instances started after the given time- Specified by:
startedAfter
in interfaceProcessInstanceQuery
-
startedBy
Description copied from interface:ProcessInstanceQuery
Only select process instances started by the given user id- Specified by:
startedBy
in interfaceProcessInstanceQuery
-
orderByProcessInstanceId
Description copied from interface:ProcessInstanceQuery
Order by id (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessInstanceId
in interfaceProcessInstanceQuery
-
orderByProcessDefinitionId
Description copied from interface:ProcessInstanceQuery
Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessDefinitionId
in interfaceProcessInstanceQuery
-
orderByProcessDefinitionKey
Description copied from interface:ProcessInstanceQuery
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessDefinitionKey
in interfaceProcessInstanceQuery
-
orderByStartTime
Description copied from interface:ProcessInstanceQuery
Order by start time (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByStartTime
in interfaceProcessInstanceQuery
-
orderByTenantId
Description copied from interface:ProcessInstanceQuery
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByTenantId
in interfaceProcessInstanceQuery
-
executeCount
public long executeCount(org.flowable.common.engine.impl.interceptor.CommandContext commandContext) - Specified by:
executeCount
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance>
-
executeList
public List<ProcessInstance> executeList(org.flowable.common.engine.impl.interceptor.CommandContext commandContext) - Specified by:
executeList
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance>
-
enhanceCachedValue
public void enhanceCachedValue(org.flowable.engine.impl.persistence.entity.ExecutionEntity processInstance) - Specified by:
enhanceCachedValue
in interfaceorg.flowable.common.engine.api.query.CacheAwareQuery<org.flowable.engine.impl.persistence.entity.ExecutionEntity>
-
ensureVariablesInitialized
protected void ensureVariablesInitialized()- Overrides:
ensureVariablesInitialized
in classorg.flowable.variable.service.impl.AbstractVariableQueryImpl<ProcessInstanceQuery,
ProcessInstance>
-
getOnlyProcessInstances
public boolean getOnlyProcessInstances() -
getProcessInstanceId
-
getId
- Specified by:
getId
in interfaceorg.flowable.common.engine.api.query.CacheAwareQuery<org.flowable.engine.impl.persistence.entity.ExecutionEntity>
-
getRootProcessInstanceId
-
getProcessInstanceIds
-
getRootScopeId
-
getBusinessKey
-
getBusinessKeyLike
-
getBusinessKeyLikeIgnoreCase
-
getBusinessStatus
-
getBusinessStatusLike
-
getBusinessStatusLikeIgnoreCase
-
isIncludeChildExecutionsWithBusinessKeyQuery
public boolean isIncludeChildExecutionsWithBusinessKeyQuery() -
getProcessDefinitionId
-
getProcessDefinitionIds
-
getProcessDefinitionCategory
-
getProcessDefinitionCategoryLike
-
getProcessDefinitionCategoryLikeIgnoreCase
-
getParentScopeId
-
getProcessDefinitionName
-
getProcessDefinitionNameLike
-
getProcessDefinitionNameLikeIgnoreCase
-
getProcessDefinitionVersion
-
getProcessDefinitionKey
-
getProcessDefinitionKeyLike
-
getProcessDefinitionKeyLikeIgnoreCase
-
getProcessDefinitionKeys
-
getProcessDefinitionEngineVersion
-
getActivityId
-
getSuperProcessInstanceId
-
getSubProcessInstanceId
-
isExcludeSubprocesses
public boolean isExcludeSubprocesses() -
getInvolvedUser
-
getInvolvedUserIdentityLink
-
getInvolvedGroupIdentityLink
-
getInvolvedGroups
-
getSuspensionState
public org.flowable.common.engine.impl.db.SuspensionState getSuspensionState() -
setSuspensionState
public void setSuspensionState(org.flowable.common.engine.impl.db.SuspensionState suspensionState) -
getEventSubscriptions
public List<org.flowable.eventsubscription.service.impl.EventSubscriptionQueryValue> getEventSubscriptions() -
setEventSubscriptions
public void setEventSubscriptions(List<org.flowable.eventsubscription.service.impl.EventSubscriptionQueryValue> eventSubscriptions) -
getTenantId
-
getTenantIdLike
-
getTenantIdLikeIgnoreCase
-
isWithoutTenantId
public boolean isWithoutTenantId() -
getName
-
getNameLike
-
setName
-
setNameLike
-
getExecutionId
-
getDeploymentId
-
getDeploymentIds
-
isIncludeProcessVariables
public boolean isIncludeProcessVariables() -
iswithException
public boolean iswithException() -
getNameLikeIgnoreCase
-
getActiveActivityId
-
getActiveActivityIds
-
getCallbackId
-
getCallbackType
-
getReferenceId
-
getReferenceType
-
getOrQueryObjects
-
getParentId
Methods needed for ibatis because of re-use of query-xml for executions. ExecutionQuery contains a parentId property. -
isOnlyChildExecutions
public boolean isOnlyChildExecutions() -
isOnlyProcessInstanceExecutions
public boolean isOnlyProcessInstanceExecutions() -
isOnlySubProcessExecutions
public boolean isOnlySubProcessExecutions() -
getStartedBefore
-
setStartedBefore
-
getStartedAfter
-
setStartedAfter
-
getStartedBy
-
setStartedBy
-
isWithJobException
public boolean isWithJobException() -
getLocale
-
isNeedsProcessDefinitionOuterJoin
public boolean isNeedsProcessDefinitionOuterJoin() -
getSafeInvolvedGroups
-
setSafeInvolvedGroups
-