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:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl
queryVariableValues, variableValueProvider
-
-
Constructor Summary
Constructors Constructor Description ProcessInstanceQueryImpl()
ProcessInstanceQueryImpl(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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProcessInstanceQuery
active()
Only select process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.ProcessInstanceQuery
activeActivityId(String activityId)
Select the process instances which have an active activity instance like the provided id.ProcessInstanceQuery
activeActivityIds(Set<String> activityIds)
Select the process instances which have an active activity instance like the provided ids.ProcessInstanceQueryImpl
deploymentId(String deploymentId)
Select the process instances which are defined by a deployment with the given id.ProcessInstanceQueryImpl
deploymentIdIn(List<String> deploymentIds)
Select the process instances which are defined by one of the given deployment idsProcessInstanceQuery
endOr()
End an OR statement.void
enhanceCachedValue(org.flowable.engine.impl.persistence.entity.ExecutionEntity processInstance)
protected void
ensureVariablesInitialized()
ProcessInstanceQuery
excludeSubprocesses(boolean excludeSubprocesses)
Exclude sub processes from the query result;long
executeCount(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
List<ProcessInstance>
executeList(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
String
getActiveActivityId()
Set<String>
getActiveActivityIds()
String
getActivityId()
String
getBusinessKey()
String
getBusinessKeyLike()
String
getBusinessStatus()
String
getBusinessStatusLike()
String
getCallbackId()
String
getCallbackType()
String
getDeploymentId()
List<String>
getDeploymentIds()
List<org.flowable.eventsubscription.service.impl.EventSubscriptionQueryValue>
getEventSubscriptions()
String
getExecutionId()
String
getId()
IdentityLinkQueryObject
getInvolvedGroupIdentityLink()
Set<String>
getInvolvedGroups()
String
getInvolvedUser()
IdentityLinkQueryObject
getInvolvedUserIdentityLink()
String
getLocale()
String
getName()
String
getNameLike()
String
getNameLikeIgnoreCase()
boolean
getOnlyProcessInstances()
List<ProcessInstanceQueryImpl>
getOrQueryObjects()
String
getParentId()
Methods needed for ibatis because of re-use of query-xml for executions.String
getProcessDefinitionCategory()
String
getProcessDefinitionEngineVersion()
String
getProcessDefinitionId()
Set<String>
getProcessDefinitionIds()
String
getProcessDefinitionKey()
Set<String>
getProcessDefinitionKeys()
String
getProcessDefinitionName()
Integer
getProcessDefinitionVersion()
String
getProcessInstanceId()
Set<String>
getProcessInstanceIds()
String
getReferenceId()
String
getReferenceType()
String
getRootProcessInstanceId()
List<List<String>>
getSafeInvolvedGroups()
Date
getStartedAfter()
Date
getStartedBefore()
String
getStartedBy()
String
getSubProcessInstanceId()
String
getSuperProcessInstanceId()
org.flowable.common.engine.impl.db.SuspensionState
getSuspensionState()
String
getTenantId()
String
getTenantIdLike()
ProcessInstanceQuery
includeProcessVariables()
Include process variables in the process query resultProcessInstanceQuery
involvedGroup(String groupId, String identityLinkType)
Select the process instances with which the group with the given id and identity link type is involved.ProcessInstanceQuery
involvedGroups(Set<String> involvedGroups)
Select the process instances with which theGroup
s with the given ids are involved.ProcessInstanceQuery
involvedUser(String involvedUser)
Select the process instances with which the user with the given id is involved.ProcessInstanceQuery
involvedUser(String userId, String identityLinkType)
Select the process instances with which the user with the given id and identity link type is involved.boolean
isExcludeSubprocesses()
boolean
isIncludeChildExecutionsWithBusinessKeyQuery()
boolean
isIncludeProcessVariables()
boolean
isNeedsProcessDefinitionOuterJoin()
boolean
isOnlyChildExecutions()
boolean
isOnlyProcessInstanceExecutions()
boolean
isOnlySubProcessExecutions()
boolean
iswithException()
boolean
isWithJobException()
boolean
isWithoutTenantId()
ProcessInstanceQuery
limitProcessInstanceVariables(Integer processInstanceVariablesLimit)
Limit process instance variablesProcessInstanceQuery
locale(String locale)
Localize process name and description to specified locale.ProcessInstanceQuery
or()
Begin an OR statement.ProcessInstanceQuery
orderByProcessDefinitionId()
Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery
orderByProcessDefinitionKey()
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery
orderByProcessInstanceId()
Order by id (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery
orderByStartTime()
Order by start time (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery
orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).ProcessInstanceQuery
processDefinitionCategory(String processDefinitionCategory)
Only select process instances whose process definition category is processDefinitionCategory.ProcessInstanceQuery
processDefinitionEngineVersion(String processDefinitionEngineVersion)
Select the process instances which are defined by a process definition with the given engine version.ProcessInstanceQueryImpl
processDefinitionId(String processDefinitionId)
Select the process instances which are defined by a process definition with the given id.ProcessInstanceQuery
processDefinitionIds(Set<String> processDefinitionIds)
Select the process instances which are defined by process definitions with the given ids.ProcessInstanceQueryImpl
processDefinitionKey(String processDefinitionKey)
Select the process instances which are defined by a process definition with the given key.ProcessInstanceQuery
processDefinitionKeys(Set<String> processDefinitionKeys)
Select the process instances which are defined by process definitions with the given keys.ProcessInstanceQuery
processDefinitionName(String processDefinitionName)
Select process instances whose process definition name is processDefinitionNameProcessInstanceQuery
processDefinitionVersion(Integer processDefinitionVersion)
Only select process instances with a certain process definition version.ProcessInstanceQuery
processInstanceBusinessKey(String businessKey)
Select process instances with the given business keyProcessInstanceQuery
processInstanceBusinessKey(String businessKey, String processDefinitionKey)
Select process instance with the given business key, unique for the given process definitionProcessInstanceQuery
processInstanceBusinessKeyLike(String businessKeyLike)
Select process instances with a business key like the given value.ProcessInstanceQuery
processInstanceBusinessStatus(String businessStatus)
Select process instances with the given business statusProcessInstanceQuery
processInstanceBusinessStatusLike(String businessStatusLike)
Select process instances with a business status like the given value.ProcessInstanceQuery
processInstanceCallbackId(String callbackId)
Only select process instances with the given callback id.ProcessInstanceQuery
processInstanceCallbackType(String callbackType)
Only select process instances with the given callback type.ProcessInstanceQueryImpl
processInstanceId(String processInstanceId)
Select the process instance with the given idProcessInstanceQuery
processInstanceIds(Set<String> processInstanceIds)
Select process instances whose id is in the given set of idsProcessInstanceQuery
processInstanceName(String name)
Only select process instances with the given name.ProcessInstanceQuery
processInstanceNameLike(String nameLike)
Only select process instances with a name like the given value.ProcessInstanceQuery
processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)
Only select process instances with a name like the given value, ignoring upper/lower case.ProcessInstanceQuery
processInstanceReferenceId(String referenceId)
Only select process instances with the given reference id.ProcessInstanceQuery
processInstanceReferenceType(String referenceType)
Only select process instances with the given callback type.ProcessInstanceQuery
processInstanceTenantId(String tenantId)
Only select process instances that have the given tenant id.ProcessInstanceQuery
processInstanceTenantIdLike(String tenantIdLike)
Only select process instances with a tenant id like the given one.ProcessInstanceQuery
processInstanceWithoutTenantId()
Only select process instances that do not have a tenant id.void
setEventSubscriptions(List<org.flowable.eventsubscription.service.impl.EventSubscriptionQueryValue> eventSubscriptions)
void
setName(String name)
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)
ProcessInstanceQuery
startedAfter(Date afterTime)
Only select process instances started after the given timeProcessInstanceQuery
startedBefore(Date beforeTime)
Only select process instances started before the given timeProcessInstanceQuery
startedBy(String userId)
Only select process instances started by the given user idProcessInstanceQuery
subProcessInstanceId(String subProcessInstanceId)
Select the process instance that have as sub process instance the given process instance.ProcessInstanceQuery
superProcessInstanceId(String superProcessInstanceId)
Select the process instances which are a sub process instance of the given super process instance.ProcessInstanceQuery
suspended()
Only select process instances which are suspended, either because the process instance itself is suspended or because the corresponding process definition is suspendedProcessInstanceQuery
variableExists(String name)
Only select process instances which have a variable with the given name.ProcessInstanceQuery
variableNotExists(String name)
Only select process instances which does not have a variable with the given name.ProcessInstanceQuery
variableValueEquals(Object variableValue)
Only select process instances which have at least one global variable with the given value.ProcessInstanceQuery
variableValueEquals(String variableName, Object variableValue)
Only select process instances which have a global variable with the given value.ProcessInstanceQuery
variableValueEqualsIgnoreCase(String name, String value)
Only select process instances which have a local string variable with the given value, case insensitive.ProcessInstanceQuery
variableValueGreaterThan(String name, Object value)
Only select process instances which have a variable value greater than the passed value.ProcessInstanceQuery
variableValueGreaterThanOrEqual(String name, Object value)
Only select process instances which have a global variable value greater than or equal to the passed value.ProcessInstanceQuery
variableValueLessThan(String name, Object value)
Only select process instances which have a global variable value less than the passed value.ProcessInstanceQuery
variableValueLessThanOrEqual(String name, Object value)
Only select process instances which have a global variable value less than or equal to the passed value.ProcessInstanceQuery
variableValueLike(String name, String value)
Only select process instances which have a global variable value like the given value.ProcessInstanceQuery
variableValueLikeIgnoreCase(String name, String value)
Only select process instances which have a global variable value like the given value (case insensitive).ProcessInstanceQuery
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.ProcessInstanceQuery
variableValueNotEqualsIgnoreCase(String name, String value)
Only select process instances which have a local string variable which is not the given value, case insensitive.ProcessInstanceQuery
withJobException()
Only select process instances that failed due to an exception happening during a job execution.ProcessInstanceQuery
withLocalizationFallback()
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
-
-
-
-
Field Detail
-
processEngineConfiguration
protected org.flowable.engine.impl.cfg.ProcessEngineConfigurationImpl processEngineConfiguration
-
executionId
protected String executionId
-
businessKey
protected String businessKey
-
businessKeyLike
protected String businessKeyLike
-
includeChildExecutionsWithBusinessKeyQuery
protected boolean includeChildExecutionsWithBusinessKeyQuery
-
businessStatus
protected String businessStatus
-
businessStatusLike
protected String businessStatusLike
-
processDefinitionId
protected String processDefinitionId
-
processDefinitionCategory
protected String processDefinitionCategory
-
processDefinitionName
protected String processDefinitionName
-
processDefinitionVersion
protected Integer processDefinitionVersion
-
processDefinitionKey
protected String processDefinitionKey
-
processDefinitionEngineVersion
protected String processDefinitionEngineVersion
-
deploymentId
protected String deploymentId
-
superProcessInstanceId
protected String superProcessInstanceId
-
subProcessInstanceId
protected String subProcessInstanceId
-
excludeSubprocesses
protected boolean excludeSubprocesses
-
involvedUser
protected String involvedUser
-
involvedUserIdentityLink
protected IdentityLinkQueryObject involvedUserIdentityLink
-
involvedGroupIdentityLink
protected IdentityLinkQueryObject involvedGroupIdentityLink
-
suspensionState
protected org.flowable.common.engine.impl.db.SuspensionState suspensionState
-
includeProcessVariables
protected boolean includeProcessVariables
-
withJobException
protected boolean withJobException
-
name
protected String name
-
nameLike
protected String nameLike
-
nameLikeIgnoreCase
protected String nameLikeIgnoreCase
-
activeActivityId
protected String activeActivityId
-
callbackId
protected String callbackId
-
callbackType
protected String callbackType
-
referenceId
protected String referenceId
-
referenceType
protected String referenceType
-
locale
protected String locale
-
withLocalizationFallback
protected boolean withLocalizationFallback
-
tenantId
protected String tenantId
-
tenantIdLike
protected String tenantIdLike
-
withoutTenantId
protected boolean withoutTenantId
-
orQueryObjects
protected List<ProcessInstanceQueryImpl> orQueryObjects
-
currentOrQueryObject
protected ProcessInstanceQueryImpl currentOrQueryObject
-
inOrStatement
protected boolean inOrStatement
-
startedBefore
protected Date startedBefore
-
startedAfter
protected Date startedAfter
-
startedBy
protected String startedBy
-
activityId
protected String activityId
-
eventSubscriptions
protected List<org.flowable.eventsubscription.service.impl.EventSubscriptionQueryValue> eventSubscriptions
-
onlyChildExecutions
protected boolean onlyChildExecutions
-
onlyProcessInstanceExecutions
protected boolean onlyProcessInstanceExecutions
-
onlySubProcessExecutions
protected boolean onlySubProcessExecutions
-
rootProcessInstanceId
protected String rootProcessInstanceId
-
-
Constructor Detail
-
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 Detail
-
processInstanceId
public ProcessInstanceQueryImpl processInstanceId(String processInstanceId)
Description copied from interface:ProcessInstanceQuery
Select the process instance with the given id- Specified by:
processInstanceId
in interfaceProcessInstanceQuery
-
processInstanceIds
public ProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
Description copied from interface:ProcessInstanceQuery
Select process instances whose id is in the given set of ids- Specified by:
processInstanceIds
in interfaceProcessInstanceQuery
-
processInstanceBusinessKey
public ProcessInstanceQuery processInstanceBusinessKey(String businessKey)
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
public ProcessInstanceQuery processInstanceBusinessKeyLike(String businessKeyLike)
Description copied from interface:ProcessInstanceQuery
Select process instances with a business key like the given value.- Specified by:
processInstanceBusinessKeyLike
in interfaceProcessInstanceQuery
-
processInstanceBusinessStatus
public ProcessInstanceQuery processInstanceBusinessStatus(String businessStatus)
Description copied from interface:ProcessInstanceQuery
Select process instances with the given business status- Specified by:
processInstanceBusinessStatus
in interfaceProcessInstanceQuery
-
processInstanceBusinessStatusLike
public ProcessInstanceQuery processInstanceBusinessStatusLike(String businessStatusLike)
Description copied from interface:ProcessInstanceQuery
Select process instances with a business status like the given value.- Specified by:
processInstanceBusinessStatusLike
in interfaceProcessInstanceQuery
-
processInstanceTenantId
public ProcessInstanceQuery processInstanceTenantId(String tenantId)
Description copied from interface:ProcessInstanceQuery
Only select process instances that have the given tenant id.- Specified by:
processInstanceTenantId
in interfaceProcessInstanceQuery
-
processInstanceTenantIdLike
public ProcessInstanceQuery processInstanceTenantIdLike(String tenantIdLike)
Description copied from interface:ProcessInstanceQuery
Only select process instances with a tenant id like the given one.- Specified by:
processInstanceTenantIdLike
in interfaceProcessInstanceQuery
-
processInstanceWithoutTenantId
public ProcessInstanceQuery processInstanceWithoutTenantId()
Description copied from interface:ProcessInstanceQuery
Only select process instances that do not have a tenant id.- Specified by:
processInstanceWithoutTenantId
in interfaceProcessInstanceQuery
-
processDefinitionCategory
public ProcessInstanceQuery processDefinitionCategory(String processDefinitionCategory)
Description copied from interface:ProcessInstanceQuery
Only select process instances whose process definition category is processDefinitionCategory.- Specified by:
processDefinitionCategory
in interfaceProcessInstanceQuery
-
processDefinitionName
public ProcessInstanceQuery processDefinitionName(String processDefinitionName)
Description copied from interface:ProcessInstanceQuery
Select process instances whose process definition name is processDefinitionName- Specified by:
processDefinitionName
in interfaceProcessInstanceQuery
-
processDefinitionVersion
public ProcessInstanceQuery processDefinitionVersion(Integer 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
public ProcessInstanceQueryImpl processDefinitionId(String 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
public ProcessInstanceQuery processDefinitionIds(Set<String> 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
public ProcessInstanceQueryImpl processDefinitionKey(String 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
-
processDefinitionKeys
public ProcessInstanceQuery processDefinitionKeys(Set<String> 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
public ProcessInstanceQuery processDefinitionEngineVersion(String 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
public ProcessInstanceQueryImpl deploymentId(String 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
public ProcessInstanceQueryImpl deploymentIdIn(List<String> deploymentIds)
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
public ProcessInstanceQuery superProcessInstanceId(String 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
public ProcessInstanceQuery subProcessInstanceId(String 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
public ProcessInstanceQuery excludeSubprocesses(boolean excludeSubprocesses)
Description copied from interface:ProcessInstanceQuery
Exclude sub processes from the query result;- Specified by:
excludeSubprocesses
in interfaceProcessInstanceQuery
-
involvedUser
public ProcessInstanceQuery involvedUser(String 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
public ProcessInstanceQuery involvedUser(String userId, String identityLinkType)
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
public ProcessInstanceQuery involvedGroup(String groupId, String identityLinkType)
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
public ProcessInstanceQuery involvedGroups(Set<String> 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
public ProcessInstanceQuery 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
public ProcessInstanceQuery 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
public ProcessInstanceQuery includeProcessVariables()
Description copied from interface:ProcessInstanceQuery
Include process variables in the process query result- Specified by:
includeProcessVariables
in interfaceProcessInstanceQuery
-
limitProcessInstanceVariables
public ProcessInstanceQuery limitProcessInstanceVariables(Integer processInstanceVariablesLimit)
Description copied from interface:ProcessInstanceQuery
Limit process instance variables- Specified by:
limitProcessInstanceVariables
in interfaceProcessInstanceQuery
-
withJobException
public ProcessInstanceQuery 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
public ProcessInstanceQuery processInstanceName(String name)
Description copied from interface:ProcessInstanceQuery
Only select process instances with the given name.- Specified by:
processInstanceName
in interfaceProcessInstanceQuery
-
processInstanceNameLike
public ProcessInstanceQuery processInstanceNameLike(String nameLike)
Description copied from interface:ProcessInstanceQuery
Only select process instances with a name like the given value.- Specified by:
processInstanceNameLike
in interfaceProcessInstanceQuery
-
processInstanceNameLikeIgnoreCase
public ProcessInstanceQuery processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)
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
-
activeActivityId
public ProcessInstanceQuery activeActivityId(String activityId)
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
public ProcessInstanceQuery activeActivityIds(Set<String> activityIds)
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
public ProcessInstanceQuery processInstanceCallbackId(String callbackId)
Description copied from interface:ProcessInstanceQuery
Only select process instances with the given callback id.- Specified by:
processInstanceCallbackId
in interfaceProcessInstanceQuery
-
processInstanceCallbackType
public ProcessInstanceQuery processInstanceCallbackType(String callbackType)
Description copied from interface:ProcessInstanceQuery
Only select process instances with the given callback type.- Specified by:
processInstanceCallbackType
in interfaceProcessInstanceQuery
-
processInstanceReferenceId
public ProcessInstanceQuery processInstanceReferenceId(String referenceId)
Description copied from interface:ProcessInstanceQuery
Only select process instances with the given reference id.- Specified by:
processInstanceReferenceId
in interfaceProcessInstanceQuery
-
processInstanceReferenceType
public ProcessInstanceQuery processInstanceReferenceType(String referenceType)
Description copied from interface:ProcessInstanceQuery
Only select process instances with the given callback type.- Specified by:
processInstanceReferenceType
in interfaceProcessInstanceQuery
-
or
public ProcessInstanceQuery 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
public ProcessInstanceQuery 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
public ProcessInstanceQuery variableValueEquals(String variableName, Object variableValue)
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
public ProcessInstanceQuery variableValueNotEquals(String variableName, Object variableValue)
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
public ProcessInstanceQuery variableValueEquals(Object variableValue)
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
public ProcessInstanceQuery variableValueEqualsIgnoreCase(String name, String value)
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
public ProcessInstanceQuery variableValueNotEqualsIgnoreCase(String name, String value)
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
public ProcessInstanceQuery variableValueGreaterThan(String name, Object value)
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
public ProcessInstanceQuery variableValueGreaterThanOrEqual(String name, Object value)
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
public ProcessInstanceQuery variableValueLessThan(String name, Object value)
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
public ProcessInstanceQuery variableValueLessThanOrEqual(String name, Object value)
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
public ProcessInstanceQuery variableValueLike(String name, String value)
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
public ProcessInstanceQuery variableValueLikeIgnoreCase(String name, String value)
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
public ProcessInstanceQuery variableExists(String name)
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
public ProcessInstanceQuery variableNotExists(String name)
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
public ProcessInstanceQuery locale(String locale)
Description copied from interface:ProcessInstanceQuery
Localize process name and description to specified locale.- Specified by:
locale
in interfaceProcessInstanceQuery
-
withLocalizationFallback
public ProcessInstanceQuery 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
public ProcessInstanceQuery startedBefore(Date beforeTime)
Description copied from interface:ProcessInstanceQuery
Only select process instances started before the given time- Specified by:
startedBefore
in interfaceProcessInstanceQuery
-
startedAfter
public ProcessInstanceQuery startedAfter(Date afterTime)
Description copied from interface:ProcessInstanceQuery
Only select process instances started after the given time- Specified by:
startedAfter
in interfaceProcessInstanceQuery
-
startedBy
public ProcessInstanceQuery startedBy(String userId)
Description copied from interface:ProcessInstanceQuery
Only select process instances started by the given user id- Specified by:
startedBy
in interfaceProcessInstanceQuery
-
orderByProcessInstanceId
public ProcessInstanceQuery orderByProcessInstanceId()
Description copied from interface:ProcessInstanceQuery
Order by id (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessInstanceId
in interfaceProcessInstanceQuery
-
orderByProcessDefinitionId
public ProcessInstanceQuery 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
public ProcessInstanceQuery 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
public ProcessInstanceQuery orderByStartTime()
Description copied from interface:ProcessInstanceQuery
Order by start time (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByStartTime
in interfaceProcessInstanceQuery
-
orderByTenantId
public ProcessInstanceQuery 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
public String getProcessInstanceId()
-
getId
public String getId()
- Specified by:
getId
in interfaceorg.flowable.common.engine.api.query.CacheAwareQuery<org.flowable.engine.impl.persistence.entity.ExecutionEntity>
-
getRootProcessInstanceId
public String getRootProcessInstanceId()
-
getBusinessKey
public String getBusinessKey()
-
getBusinessKeyLike
public String getBusinessKeyLike()
-
getBusinessStatus
public String getBusinessStatus()
-
getBusinessStatusLike
public String getBusinessStatusLike()
-
isIncludeChildExecutionsWithBusinessKeyQuery
public boolean isIncludeChildExecutionsWithBusinessKeyQuery()
-
getProcessDefinitionId
public String getProcessDefinitionId()
-
getProcessDefinitionCategory
public String getProcessDefinitionCategory()
-
getProcessDefinitionName
public String getProcessDefinitionName()
-
getProcessDefinitionVersion
public Integer getProcessDefinitionVersion()
-
getProcessDefinitionKey
public String getProcessDefinitionKey()
-
getProcessDefinitionEngineVersion
public String getProcessDefinitionEngineVersion()
-
getActivityId
public String getActivityId()
-
getSuperProcessInstanceId
public String getSuperProcessInstanceId()
-
getSubProcessInstanceId
public String getSubProcessInstanceId()
-
isExcludeSubprocesses
public boolean isExcludeSubprocesses()
-
getInvolvedUser
public String getInvolvedUser()
-
getInvolvedUserIdentityLink
public IdentityLinkQueryObject getInvolvedUserIdentityLink()
-
getInvolvedGroupIdentityLink
public IdentityLinkQueryObject getInvolvedGroupIdentityLink()
-
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
public String getTenantId()
-
getTenantIdLike
public String getTenantIdLike()
-
isWithoutTenantId
public boolean isWithoutTenantId()
-
getName
public String getName()
-
getNameLike
public String getNameLike()
-
setName
public void setName(String name)
-
setNameLike
public void setNameLike(String nameLike)
-
getExecutionId
public String getExecutionId()
-
getDeploymentId
public String getDeploymentId()
-
isIncludeProcessVariables
public boolean isIncludeProcessVariables()
-
iswithException
public boolean iswithException()
-
getNameLikeIgnoreCase
public String getNameLikeIgnoreCase()
-
getActiveActivityId
public String getActiveActivityId()
-
getCallbackId
public String getCallbackId()
-
getCallbackType
public String getCallbackType()
-
getReferenceId
public String getReferenceId()
-
getReferenceType
public String getReferenceType()
-
getOrQueryObjects
public List<ProcessInstanceQueryImpl> getOrQueryObjects()
-
getParentId
public String 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
public Date getStartedBefore()
-
setStartedBefore
public void setStartedBefore(Date startedBefore)
-
getStartedAfter
public Date getStartedAfter()
-
setStartedAfter
public void setStartedAfter(Date startedAfter)
-
getStartedBy
public String getStartedBy()
-
setStartedBy
public void setStartedBy(String startedBy)
-
isWithJobException
public boolean isWithJobException()
-
getLocale
public String getLocale()
-
isNeedsProcessDefinitionOuterJoin
public boolean isNeedsProcessDefinitionOuterJoin()
-
-