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,CacheAwareQuery<ExecutionEntity>,Query<ProcessInstanceQuery,ProcessInstance>,Command<Object>,ProcessInstanceQuery
public class ProcessInstanceQueryImpl extends AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance> implements ProcessInstanceQuery, CacheAwareQuery<ExecutionEntity>, Serializable
- Author:
- Tom Baeyens, Joram Barrez, Tijs Rademakers, Frederik Heremans, Falko Menge, Daniel Meyer
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType
-
Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
Query.NullHandlingOnOrder
-
-
Field Summary
-
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
Constructors Constructor Description ProcessInstanceQueryImpl()ProcessInstanceQueryImpl(CommandContext commandContext, ProcessEngineConfigurationImpl processEngineConfiguration)ProcessInstanceQueryImpl(CommandExecutor commandExecutor, ProcessEngineConfigurationImpl processEngineConfiguration)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProcessInstanceQueryactive()Only select process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.ProcessInstanceQueryactiveActivityId(String activityId)Select the process instances which have an active activity instance like the provided id.ProcessInstanceQueryactiveActivityIds(Set<String> activityIds)Select the process instances which have an active activity instance like the provided ids.ProcessInstanceQueryImpldeploymentId(String deploymentId)Select the process instances which are defined by a deployment with the given id.ProcessInstanceQueryImpldeploymentIdIn(List<String> deploymentIds)Select the process instances which are defined by one of the given deployment idsProcessInstanceQueryendOr()End an OR statement.voidenhanceCachedValue(ExecutionEntity processInstance)protected voidensureVariablesInitialized()ProcessInstanceQueryexcludeSubprocesses(boolean excludeSubprocesses)Exclude sub processes from the query result;longexecuteCount(CommandContext commandContext)List<ProcessInstance>executeList(CommandContext commandContext)StringgetActiveActivityId()Set<String>getActiveActivityIds()StringgetActivityId()StringgetBusinessKey()StringgetBusinessKeyLike()StringgetBusinessStatus()StringgetBusinessStatusLike()StringgetCallbackId()StringgetCallbackType()StringgetDeploymentId()List<String>getDeploymentIds()List<EventSubscriptionQueryValue>getEventSubscriptions()StringgetExecutionId()StringgetId()IdentityLinkQueryObjectgetInvolvedGroupIdentityLink()Set<String>getInvolvedGroups()StringgetInvolvedUser()IdentityLinkQueryObjectgetInvolvedUserIdentityLink()StringgetLocale()StringgetName()StringgetNameLike()StringgetNameLikeIgnoreCase()booleangetOnlyProcessInstances()List<ProcessInstanceQueryImpl>getOrQueryObjects()StringgetParentId()Methods needed for ibatis because of re-use of query-xml for executions.StringgetProcessDefinitionCategory()StringgetProcessDefinitionEngineVersion()StringgetProcessDefinitionId()Set<String>getProcessDefinitionIds()StringgetProcessDefinitionKey()Set<String>getProcessDefinitionKeys()StringgetProcessDefinitionName()IntegergetProcessDefinitionVersion()StringgetProcessInstanceId()Set<String>getProcessInstanceIds()StringgetReferenceId()StringgetReferenceType()StringgetRootProcessInstanceId()List<List<String>>getSafeInvolvedGroups()DategetStartedAfter()DategetStartedBefore()StringgetStartedBy()StringgetSubProcessInstanceId()StringgetSuperProcessInstanceId()SuspensionStategetSuspensionState()StringgetTenantId()StringgetTenantIdLike()ProcessInstanceQueryincludeProcessVariables()Include process variables in the process query resultProcessInstanceQueryinvolvedGroup(String groupId, String identityLinkType)Select the process instances with which the group with the given id and identity link type is involved.ProcessInstanceQueryinvolvedGroups(Set<String> involvedGroups)Select the process instances with which theGroups with the given ids are involved.ProcessInstanceQueryinvolvedUser(String involvedUser)Select the process instances with which the user with the given id is involved.ProcessInstanceQueryinvolvedUser(String userId, String identityLinkType)Select the process instances with which the user with the given id and identity link type is involved.booleanisExcludeSubprocesses()booleanisIncludeChildExecutionsWithBusinessKeyQuery()booleanisIncludeProcessVariables()booleanisNeedsProcessDefinitionOuterJoin()booleanisOnlyChildExecutions()booleanisOnlyProcessInstanceExecutions()booleanisOnlySubProcessExecutions()booleaniswithException()booleanisWithJobException()booleanisWithoutTenantId()ProcessInstanceQuerylimitProcessInstanceVariables(Integer processInstanceVariablesLimit)Limit process instance variablesProcessInstanceQuerylocale(String locale)Localize process name and description to specified locale.ProcessInstanceQueryor()Begin an OR statement.ProcessInstanceQueryorderByProcessDefinitionId()Order by process definition id (needs to be followed byQuery.asc()orQuery.desc()).ProcessInstanceQueryorderByProcessDefinitionKey()Order by process definition key (needs to be followed byQuery.asc()orQuery.desc()).ProcessInstanceQueryorderByProcessInstanceId()Order by id (needs to be followed byQuery.asc()orQuery.desc()).ProcessInstanceQueryorderByStartTime()Order by start time (needs to be followed byQuery.asc()orQuery.desc()).ProcessInstanceQueryorderByTenantId()Order by tenant id (needs to be followed byQuery.asc()orQuery.desc()).ProcessInstanceQueryprocessDefinitionCategory(String processDefinitionCategory)Only select process instances whose process definition category is processDefinitionCategory.ProcessInstanceQueryprocessDefinitionEngineVersion(String processDefinitionEngineVersion)Select the process instances which are defined by a process definition with the given engine version.ProcessInstanceQueryImplprocessDefinitionId(String processDefinitionId)Select the process instances which are defined by a process definition with the given id.ProcessInstanceQueryprocessDefinitionIds(Set<String> processDefinitionIds)Select the process instances which are defined by process definitions with the given ids.ProcessInstanceQueryImplprocessDefinitionKey(String processDefinitionKey)Select the process instances which are defined by a process definition with the given key.ProcessInstanceQueryprocessDefinitionKeys(Set<String> processDefinitionKeys)Select the process instances which are defined by process definitions with the given keys.ProcessInstanceQueryprocessDefinitionName(String processDefinitionName)Select process instances whose process definition name is processDefinitionNameProcessInstanceQueryprocessDefinitionVersion(Integer processDefinitionVersion)Only select process instances with a certain process definition version.ProcessInstanceQueryprocessInstanceBusinessKey(String businessKey)Select process instances with the given business keyProcessInstanceQueryprocessInstanceBusinessKey(String businessKey, String processDefinitionKey)Select process instance with the given business key, unique for the given process definitionProcessInstanceQueryprocessInstanceBusinessKeyLike(String businessKeyLike)Select process instances with a business key like the given value.ProcessInstanceQueryprocessInstanceBusinessStatus(String businessStatus)Select process instances with the given business statusProcessInstanceQueryprocessInstanceBusinessStatusLike(String businessStatusLike)Select process instances with a business status like the given value.ProcessInstanceQueryprocessInstanceCallbackId(String callbackId)Only select process instances with the given callback id.ProcessInstanceQueryprocessInstanceCallbackType(String callbackType)Only select process instances with the given callback type.ProcessInstanceQueryImplprocessInstanceId(String processInstanceId)Select the process instance with the given idProcessInstanceQueryprocessInstanceIds(Set<String> processInstanceIds)Select process instances whose id is in the given set of idsProcessInstanceQueryprocessInstanceName(String name)Only select process instances with the given name.ProcessInstanceQueryprocessInstanceNameLike(String nameLike)Only select process instances with a name like the given value.ProcessInstanceQueryprocessInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)Only select process instances with a name like the given value, ignoring upper/lower case.ProcessInstanceQueryprocessInstanceReferenceId(String referenceId)Only select process instances with the given reference id.ProcessInstanceQueryprocessInstanceReferenceType(String referenceType)Only select process instances with the given callback type.ProcessInstanceQueryprocessInstanceTenantId(String tenantId)Only select process instances that have the given tenant id.ProcessInstanceQueryprocessInstanceTenantIdLike(String tenantIdLike)Only select process instances with a tenant id like the given one.ProcessInstanceQueryprocessInstanceWithoutTenantId()Only select process instances that do not have a tenant id.voidsetEventSubscriptions(List<EventSubscriptionQueryValue> eventSubscriptions)voidsetName(String name)voidsetNameLike(String nameLike)voidsetSafeInvolvedGroups(List<List<String>> safeInvolvedGroups)voidsetStartedAfter(Date startedAfter)voidsetStartedBefore(Date startedBefore)voidsetStartedBy(String startedBy)voidsetSuspensionState(SuspensionState suspensionState)ProcessInstanceQuerystartedAfter(Date afterTime)Only select process instances started after the given timeProcessInstanceQuerystartedBefore(Date beforeTime)Only select process instances started before the given timeProcessInstanceQuerystartedBy(String userId)Only select process instances started by the given user idProcessInstanceQuerysubProcessInstanceId(String subProcessInstanceId)Select the process instance that have as sub process instance the given process instance.ProcessInstanceQuerysuperProcessInstanceId(String superProcessInstanceId)Select the process instances which are a sub process instance of the given super process instance.ProcessInstanceQuerysuspended()Only select process instances which are suspended, either because the process instance itself is suspended or because the corresponding process definition is suspendedProcessInstanceQueryvariableExists(String name)Only select process instances which have a variable with the given name.ProcessInstanceQueryvariableNotExists(String name)Only select process instances which does not have a variable with the given name.ProcessInstanceQueryvariableValueEquals(Object variableValue)Only select process instances which have at least one global variable with the given value.ProcessInstanceQueryvariableValueEquals(String variableName, Object variableValue)Only select process instances which have a global variable with the given value.ProcessInstanceQueryvariableValueEqualsIgnoreCase(String name, String value)Only select process instances which have a local string variable with the given value, case insensitive.ProcessInstanceQueryvariableValueGreaterThan(String name, Object value)Only select process instances which have a variable value greater than the passed value.ProcessInstanceQueryvariableValueGreaterThanOrEqual(String name, Object value)Only select process instances which have a global variable value greater than or equal to the passed value.ProcessInstanceQueryvariableValueLessThan(String name, Object value)Only select process instances which have a global variable value less than the passed value.ProcessInstanceQueryvariableValueLessThanOrEqual(String name, Object value)Only select process instances which have a global variable value less than or equal to the passed value.ProcessInstanceQueryvariableValueLike(String name, String value)Only select process instances which have a global variable value like the given value.ProcessInstanceQueryvariableValueLikeIgnoreCase(String name, String value)Only select process instances which have a global variable value like the given value (case insensitive).ProcessInstanceQueryvariableValueNotEquals(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.ProcessInstanceQueryvariableValueNotEqualsIgnoreCase(String name, String value)Only select process instances which have a local string variable which is not the given value, case insensitive.ProcessInstanceQuerywithJobException()Only select process instances that failed due to an exception happening during a job execution.ProcessInstanceQuerywithLocalizationFallback()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 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 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<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(CommandContext commandContext, ProcessEngineConfigurationImpl processEngineConfiguration)
-
ProcessInstanceQueryImpl
public ProcessInstanceQueryImpl(CommandExecutor commandExecutor, ProcessEngineConfigurationImpl processEngineConfiguration)
-
-
Method Detail
-
processInstanceId
public ProcessInstanceQueryImpl processInstanceId(String processInstanceId)
Description copied from interface:ProcessInstanceQuerySelect the process instance with the given id- Specified by:
processInstanceIdin interfaceProcessInstanceQuery
-
processInstanceIds
public ProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
Description copied from interface:ProcessInstanceQuerySelect process instances whose id is in the given set of ids- Specified by:
processInstanceIdsin interfaceProcessInstanceQuery
-
processInstanceBusinessKey
public ProcessInstanceQuery processInstanceBusinessKey(String businessKey)
Description copied from interface:ProcessInstanceQuerySelect process instances with the given business key- Specified by:
processInstanceBusinessKeyin interfaceProcessInstanceQuery
-
processInstanceBusinessKey
public ProcessInstanceQuery processInstanceBusinessKey(String businessKey, String processDefinitionKey)
Description copied from interface:ProcessInstanceQuerySelect process instance with the given business key, unique for the given process definition- Specified by:
processInstanceBusinessKeyin interfaceProcessInstanceQuery
-
processInstanceBusinessKeyLike
public ProcessInstanceQuery processInstanceBusinessKeyLike(String businessKeyLike)
Description copied from interface:ProcessInstanceQuerySelect process instances with a business key like the given value.- Specified by:
processInstanceBusinessKeyLikein interfaceProcessInstanceQuery
-
processInstanceBusinessStatus
public ProcessInstanceQuery processInstanceBusinessStatus(String businessStatus)
Description copied from interface:ProcessInstanceQuerySelect process instances with the given business status- Specified by:
processInstanceBusinessStatusin interfaceProcessInstanceQuery
-
processInstanceBusinessStatusLike
public ProcessInstanceQuery processInstanceBusinessStatusLike(String businessStatusLike)
Description copied from interface:ProcessInstanceQuerySelect process instances with a business status like the given value.- Specified by:
processInstanceBusinessStatusLikein interfaceProcessInstanceQuery
-
processInstanceTenantId
public ProcessInstanceQuery processInstanceTenantId(String tenantId)
Description copied from interface:ProcessInstanceQueryOnly select process instances that have the given tenant id.- Specified by:
processInstanceTenantIdin interfaceProcessInstanceQuery
-
processInstanceTenantIdLike
public ProcessInstanceQuery processInstanceTenantIdLike(String tenantIdLike)
Description copied from interface:ProcessInstanceQueryOnly select process instances with a tenant id like the given one.- Specified by:
processInstanceTenantIdLikein interfaceProcessInstanceQuery
-
processInstanceWithoutTenantId
public ProcessInstanceQuery processInstanceWithoutTenantId()
Description copied from interface:ProcessInstanceQueryOnly select process instances that do not have a tenant id.- Specified by:
processInstanceWithoutTenantIdin interfaceProcessInstanceQuery
-
processDefinitionCategory
public ProcessInstanceQuery processDefinitionCategory(String processDefinitionCategory)
Description copied from interface:ProcessInstanceQueryOnly select process instances whose process definition category is processDefinitionCategory.- Specified by:
processDefinitionCategoryin interfaceProcessInstanceQuery
-
processDefinitionName
public ProcessInstanceQuery processDefinitionName(String processDefinitionName)
Description copied from interface:ProcessInstanceQuerySelect process instances whose process definition name is processDefinitionName- Specified by:
processDefinitionNamein interfaceProcessInstanceQuery
-
processDefinitionVersion
public ProcessInstanceQuery processDefinitionVersion(Integer processDefinitionVersion)
Description copied from interface:ProcessInstanceQueryOnly select process instances with a certain process definition version. Particularly useful when used in combination withProcessInstanceQuery.processDefinitionKey(String)- Specified by:
processDefinitionVersionin interfaceProcessInstanceQuery
-
processDefinitionId
public ProcessInstanceQueryImpl processDefinitionId(String processDefinitionId)
Description copied from interface:ProcessInstanceQuerySelect the process instances which are defined by a process definition with the given id.- Specified by:
processDefinitionIdin interfaceProcessInstanceQuery
-
processDefinitionIds
public ProcessInstanceQuery processDefinitionIds(Set<String> processDefinitionIds)
Description copied from interface:ProcessInstanceQuerySelect the process instances which are defined by process definitions with the given ids.- Specified by:
processDefinitionIdsin interfaceProcessInstanceQuery
-
processDefinitionKey
public ProcessInstanceQueryImpl processDefinitionKey(String processDefinitionKey)
Description copied from interface:ProcessInstanceQuerySelect the process instances which are defined by a process definition with the given key.- Specified by:
processDefinitionKeyin interfaceProcessInstanceQuery
-
processDefinitionKeys
public ProcessInstanceQuery processDefinitionKeys(Set<String> processDefinitionKeys)
Description copied from interface:ProcessInstanceQuerySelect the process instances which are defined by process definitions with the given keys.- Specified by:
processDefinitionKeysin interfaceProcessInstanceQuery
-
processDefinitionEngineVersion
public ProcessInstanceQuery processDefinitionEngineVersion(String processDefinitionEngineVersion)
Description copied from interface:ProcessInstanceQuerySelect the process instances which are defined by a process definition with the given engine version.- Specified by:
processDefinitionEngineVersionin interfaceProcessInstanceQuery
-
deploymentId
public ProcessInstanceQueryImpl deploymentId(String deploymentId)
Description copied from interface:ProcessInstanceQuerySelect the process instances which are defined by a deployment with the given id.- Specified by:
deploymentIdin interfaceProcessInstanceQuery
-
deploymentIdIn
public ProcessInstanceQueryImpl deploymentIdIn(List<String> deploymentIds)
Description copied from interface:ProcessInstanceQuerySelect the process instances which are defined by one of the given deployment ids- Specified by:
deploymentIdInin interfaceProcessInstanceQuery
-
superProcessInstanceId
public ProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)
Description copied from interface:ProcessInstanceQuerySelect the process instances which are a sub process instance of the given super process instance.- Specified by:
superProcessInstanceIdin interfaceProcessInstanceQuery
-
subProcessInstanceId
public ProcessInstanceQuery subProcessInstanceId(String subProcessInstanceId)
Description copied from interface:ProcessInstanceQuerySelect 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:
subProcessInstanceIdin interfaceProcessInstanceQuery
-
excludeSubprocesses
public ProcessInstanceQuery excludeSubprocesses(boolean excludeSubprocesses)
Description copied from interface:ProcessInstanceQueryExclude sub processes from the query result;- Specified by:
excludeSubprocessesin interfaceProcessInstanceQuery
-
involvedUser
public ProcessInstanceQuery involvedUser(String involvedUser)
Description copied from interface:ProcessInstanceQuerySelect the process instances with which the user with the given id is involved.- Specified by:
involvedUserin interfaceProcessInstanceQuery
-
involvedUser
public ProcessInstanceQuery involvedUser(String userId, String identityLinkType)
Description copied from interface:ProcessInstanceQuerySelect the process instances with which the user with the given id and identity link type is involved.- Specified by:
involvedUserin interfaceProcessInstanceQuery
-
involvedGroup
public ProcessInstanceQuery involvedGroup(String groupId, String identityLinkType)
Description copied from interface:ProcessInstanceQuerySelect the process instances with which the group with the given id and identity link type is involved.- Specified by:
involvedGroupin interfaceProcessInstanceQuery
-
involvedGroups
public ProcessInstanceQuery involvedGroups(Set<String> involvedGroups)
Description copied from interface:ProcessInstanceQuerySelect the process instances with which theGroups with the given ids are involved.- Specified by:
involvedGroupsin interfaceProcessInstanceQuery
-
active
public ProcessInstanceQuery active()
Description copied from interface:ProcessInstanceQueryOnly select process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.- Specified by:
activein interfaceProcessInstanceQuery
-
suspended
public ProcessInstanceQuery suspended()
Description copied from interface:ProcessInstanceQueryOnly select process instances which are suspended, either because the process instance itself is suspended or because the corresponding process definition is suspended- Specified by:
suspendedin interfaceProcessInstanceQuery
-
includeProcessVariables
public ProcessInstanceQuery includeProcessVariables()
Description copied from interface:ProcessInstanceQueryInclude process variables in the process query result- Specified by:
includeProcessVariablesin interfaceProcessInstanceQuery
-
limitProcessInstanceVariables
public ProcessInstanceQuery limitProcessInstanceVariables(Integer processInstanceVariablesLimit)
Description copied from interface:ProcessInstanceQueryLimit process instance variables- Specified by:
limitProcessInstanceVariablesin interfaceProcessInstanceQuery
-
withJobException
public ProcessInstanceQuery withJobException()
Description copied from interface:ProcessInstanceQueryOnly select process instances that failed due to an exception happening during a job execution.- Specified by:
withJobExceptionin interfaceProcessInstanceQuery
-
processInstanceName
public ProcessInstanceQuery processInstanceName(String name)
Description copied from interface:ProcessInstanceQueryOnly select process instances with the given name.- Specified by:
processInstanceNamein interfaceProcessInstanceQuery
-
processInstanceNameLike
public ProcessInstanceQuery processInstanceNameLike(String nameLike)
Description copied from interface:ProcessInstanceQueryOnly select process instances with a name like the given value.- Specified by:
processInstanceNameLikein interfaceProcessInstanceQuery
-
processInstanceNameLikeIgnoreCase
public ProcessInstanceQuery processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)
Description copied from interface:ProcessInstanceQueryOnly select process instances with a name like the given value, ignoring upper/lower case.- Specified by:
processInstanceNameLikeIgnoreCasein interfaceProcessInstanceQuery
-
activeActivityId
public ProcessInstanceQuery activeActivityId(String activityId)
Description copied from interface:ProcessInstanceQuerySelect the process instances which have an active activity instance like the provided id.- Specified by:
activeActivityIdin interfaceProcessInstanceQuery
-
activeActivityIds
public ProcessInstanceQuery activeActivityIds(Set<String> activityIds)
Description copied from interface:ProcessInstanceQuerySelect the process instances which have an active activity instance like the provided ids.- Specified by:
activeActivityIdsin interfaceProcessInstanceQuery
-
processInstanceCallbackId
public ProcessInstanceQuery processInstanceCallbackId(String callbackId)
Description copied from interface:ProcessInstanceQueryOnly select process instances with the given callback id.- Specified by:
processInstanceCallbackIdin interfaceProcessInstanceQuery
-
processInstanceCallbackType
public ProcessInstanceQuery processInstanceCallbackType(String callbackType)
Description copied from interface:ProcessInstanceQueryOnly select process instances with the given callback type.- Specified by:
processInstanceCallbackTypein interfaceProcessInstanceQuery
-
processInstanceReferenceId
public ProcessInstanceQuery processInstanceReferenceId(String referenceId)
Description copied from interface:ProcessInstanceQueryOnly select process instances with the given reference id.- Specified by:
processInstanceReferenceIdin interfaceProcessInstanceQuery
-
processInstanceReferenceType
public ProcessInstanceQuery processInstanceReferenceType(String referenceType)
Description copied from interface:ProcessInstanceQueryOnly select process instances with the given callback type.- Specified by:
processInstanceReferenceTypein interfaceProcessInstanceQuery
-
or
public ProcessInstanceQuery or()
Description copied from interface:ProcessInstanceQueryBegin 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:
orin interfaceProcessInstanceQuery
-
endOr
public ProcessInstanceQuery endOr()
Description copied from interface:ProcessInstanceQueryEnd an OR statement. Only one OR statement is allowed, for the second call to this method an exception will be thrown.- Specified by:
endOrin interfaceProcessInstanceQuery
-
variableValueEquals
public ProcessInstanceQuery variableValueEquals(String variableName, Object variableValue)
Description copied from interface:ProcessInstanceQueryOnly 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 andSerializableobjects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueEqualsin interfaceProcessInstanceQuery- Overrides:
variableValueEqualsin classAbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>- Parameters:
variableName- name of the variable, cannot be null.
-
variableValueNotEquals
public ProcessInstanceQuery variableValueNotEquals(String variableName, Object variableValue)
Description copied from interface:ProcessInstanceQueryOnly select process instances which have a global variable with the given name, but with a different value than the passed value. Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueNotEqualsin interfaceProcessInstanceQuery- Overrides:
variableValueNotEqualsin classAbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>- Parameters:
variableName- name of the variable, cannot be null.
-
variableValueEquals
public ProcessInstanceQuery variableValueEquals(Object variableValue)
Description copied from interface:ProcessInstanceQueryOnly 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 andSerializableobjects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueEqualsin interfaceProcessInstanceQuery- Overrides:
variableValueEqualsin classAbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
-
variableValueEqualsIgnoreCase
public ProcessInstanceQuery variableValueEqualsIgnoreCase(String name, String value)
Description copied from interface:ProcessInstanceQueryOnly 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:
variableValueEqualsIgnoreCasein interfaceProcessInstanceQuery- Overrides:
variableValueEqualsIgnoreCasein classAbstractVariableQueryImpl<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:ProcessInstanceQueryOnly 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:
variableValueNotEqualsIgnoreCasein interfaceProcessInstanceQuery- Overrides:
variableValueNotEqualsIgnoreCasein classAbstractVariableQueryImpl<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:ProcessInstanceQueryOnly select process instances which have a variable value greater than the passed value. Booleans, Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueGreaterThanin interfaceProcessInstanceQuery- Overrides:
variableValueGreaterThanin classAbstractVariableQueryImpl<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:ProcessInstanceQueryOnly select process instances which have a global variable value greater than or equal to the passed value. Booleans, Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueGreaterThanOrEqualin interfaceProcessInstanceQuery- Overrides:
variableValueGreaterThanOrEqualin classAbstractVariableQueryImpl<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:ProcessInstanceQueryOnly select process instances which have a global variable value less than the passed value. Booleans, Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueLessThanin interfaceProcessInstanceQuery- Overrides:
variableValueLessThanin classAbstractVariableQueryImpl<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:ProcessInstanceQueryOnly select process instances which have a global variable value less than or equal to the passed value. Booleans, Byte-arrays andSerializableobjects (which are not primitive type wrappers) are not supported.- Specified by:
variableValueLessThanOrEqualin interfaceProcessInstanceQuery- Overrides:
variableValueLessThanOrEqualin classAbstractVariableQueryImpl<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:ProcessInstanceQueryOnly select process instances which have a global variable value like the given value. This be used on string variables only.- Specified by:
variableValueLikein interfaceProcessInstanceQuery- Overrides:
variableValueLikein classAbstractVariableQueryImpl<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:ProcessInstanceQueryOnly select process instances which have a global variable value like the given value (case insensitive). This be used on string variables only.- Specified by:
variableValueLikeIgnoreCasein interfaceProcessInstanceQuery- Overrides:
variableValueLikeIgnoreCasein classAbstractVariableQueryImpl<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:ProcessInstanceQueryOnly select process instances which have a variable with the given name.- Specified by:
variableExistsin interfaceProcessInstanceQuery- Overrides:
variableExistsin classAbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>- Parameters:
name- cannot be null.
-
variableNotExists
public ProcessInstanceQuery variableNotExists(String name)
Description copied from interface:ProcessInstanceQueryOnly select process instances which does not have a variable with the given name.- Specified by:
variableNotExistsin interfaceProcessInstanceQuery- Overrides:
variableNotExistsin classAbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>- Parameters:
name- cannot be null.
-
locale
public ProcessInstanceQuery locale(String locale)
Description copied from interface:ProcessInstanceQueryLocalize process name and description to specified locale.- Specified by:
localein interfaceProcessInstanceQuery
-
withLocalizationFallback
public ProcessInstanceQuery withLocalizationFallback()
Description copied from interface:ProcessInstanceQueryInstruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.- Specified by:
withLocalizationFallbackin interfaceProcessInstanceQuery
-
startedBefore
public ProcessInstanceQuery startedBefore(Date beforeTime)
Description copied from interface:ProcessInstanceQueryOnly select process instances started before the given time- Specified by:
startedBeforein interfaceProcessInstanceQuery
-
startedAfter
public ProcessInstanceQuery startedAfter(Date afterTime)
Description copied from interface:ProcessInstanceQueryOnly select process instances started after the given time- Specified by:
startedAfterin interfaceProcessInstanceQuery
-
startedBy
public ProcessInstanceQuery startedBy(String userId)
Description copied from interface:ProcessInstanceQueryOnly select process instances started by the given user id- Specified by:
startedByin interfaceProcessInstanceQuery
-
orderByProcessInstanceId
public ProcessInstanceQuery orderByProcessInstanceId()
Description copied from interface:ProcessInstanceQueryOrder by id (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByProcessInstanceIdin interfaceProcessInstanceQuery
-
orderByProcessDefinitionId
public ProcessInstanceQuery orderByProcessDefinitionId()
Description copied from interface:ProcessInstanceQueryOrder by process definition id (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByProcessDefinitionIdin interfaceProcessInstanceQuery
-
orderByProcessDefinitionKey
public ProcessInstanceQuery orderByProcessDefinitionKey()
Description copied from interface:ProcessInstanceQueryOrder by process definition key (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByProcessDefinitionKeyin interfaceProcessInstanceQuery
-
orderByStartTime
public ProcessInstanceQuery orderByStartTime()
Description copied from interface:ProcessInstanceQueryOrder by start time (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByStartTimein interfaceProcessInstanceQuery
-
orderByTenantId
public ProcessInstanceQuery orderByTenantId()
Description copied from interface:ProcessInstanceQueryOrder by tenant id (needs to be followed byQuery.asc()orQuery.desc()).- Specified by:
orderByTenantIdin interfaceProcessInstanceQuery
-
executeCount
public long executeCount(CommandContext commandContext)
- Specified by:
executeCountin classAbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
-
executeList
public List<ProcessInstance> executeList(CommandContext commandContext)
- Specified by:
executeListin classAbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
-
enhanceCachedValue
public void enhanceCachedValue(ExecutionEntity processInstance)
- Specified by:
enhanceCachedValuein interfaceCacheAwareQuery<ExecutionEntity>
-
ensureVariablesInitialized
protected void ensureVariablesInitialized()
- Overrides:
ensureVariablesInitializedin classAbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>
-
getOnlyProcessInstances
public boolean getOnlyProcessInstances()
-
getProcessInstanceId
public String getProcessInstanceId()
-
getId
public String getId()
- Specified by:
getIdin interfaceCacheAwareQuery<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 SuspensionState getSuspensionState()
-
setSuspensionState
public void setSuspensionState(SuspensionState suspensionState)
-
getEventSubscriptions
public List<EventSubscriptionQueryValue> getEventSubscriptions()
-
setEventSubscriptions
public void setEventSubscriptions(List<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()
-
-