Package org.activiti.engine.impl

Class HistoricProcessInstanceQueryImpl

java.lang.Object

org.activiti.engine.impl.db.ListQueryParameterObject

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

org.activiti.engine.impl.AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

org.activiti.engine.impl.HistoricProcessInstanceQueryImpl

All Implemented Interfaces:

Serializable, HistoricProcessInstanceQuery, Command<Object>, Query<HistoricProcessInstanceQuery,HistoricProcessInstance>

public class HistoricProcessInstanceQueryImpl
extends AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>
implements HistoricProcessInstanceQuery

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.activiti.engine.impl.AbstractQuery

AbstractQuery.NullHandlingOnOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	businessKey
protected HistoricProcessInstanceQueryImpl	currentOrQueryObject
protected boolean	deleted
protected String	deploymentId
protected List<String>	deploymentIds
protected boolean	excludeSubprocesses
protected boolean	finished
protected Date	finishedAfter
protected Date	finishedBefore
protected boolean	includeProcessVariables
protected boolean	inOrStatement
protected List<String>	involvedGroups
protected String	involvedUser
protected String	locale
protected String	name
protected String	nameLike
protected String	nameLikeIgnoreCase
protected boolean	notDeleted
protected List<HistoricProcessInstanceQueryImpl>	orQueryObjects
protected String	processDefinitionCategory
protected String	processDefinitionId
protected String	processDefinitionKey
protected List<String>	processDefinitionKeyIn
protected String	processDefinitionName
protected Integer	processDefinitionVersion
protected String	processInstanceId
protected Set<String>	processInstanceIds
protected Integer	processInstanceVariablesLimit
protected List<String>	processKeyNotIn
protected Date	startedAfter
protected Date	startedBefore
protected String	startedBy
protected String	superProcessInstanceId
protected String	tenantId
protected String	tenantIdLike
protected boolean	unfinished
protected boolean	withJobException
protected boolean	withLocalizationFallback
protected boolean	withoutTenantId

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

queryVariableValues

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

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

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

firstResult, maxResults, parameter

Constructor Summary

Constructors

Constructor	Description
HistoricProcessInstanceQueryImpl()
HistoricProcessInstanceQueryImpl(CommandContext commandContext)
HistoricProcessInstanceQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
protected void	checkQueryOk()
HistoricProcessInstanceQuery	deleted()	Only select historic process instances that are deleted.
HistoricProcessInstanceQuery	deploymentId(String deploymentId)	Only select historic process instances that are defined by a process definition with the given deployment identifier.
HistoricProcessInstanceQuery	deploymentIdIn(List<String> deploymentIds)	Only select historic process instances that are defined by a process definition with one of the given deployment identifiers.
HistoricProcessInstanceQuery	endOr()	End an OR statement.
protected void	ensureVariablesInitialized()
HistoricProcessInstanceQuery	excludeSubprocesses(boolean excludeSubprocesses)	Exclude sub processes from the query result;
long	executeCount(CommandContext commandContext)
List<HistoricProcessInstance>	executeList(CommandContext commandContext, Page page)	Executes the actual query to retrieve the list of results.
HistoricProcessInstanceQuery	finished()	Only select historic process instances that are completely finished.
HistoricProcessInstanceQuery	finishedAfter(Date finishedAfter)	Only select historic process instances that were started after the given date.
HistoricProcessInstanceQuery	finishedBefore(Date finishedBefore)	Only select historic process instances that were started before the given date.
String	getBusinessKey()
String	getDeploymentId()
List<String>	getDeploymentIds()
Date	getFinishedAfter()
Date	getFinishedBefore()
List<String>	getInvolvedGroups()
String	getInvolvedUser()
String	getMssqlOrDB2OrderBy()
String	getName()
String	getNameLike()
String	getNameLikeIgnoreCase()
List<HistoricProcessInstanceQueryImpl>	getOrQueryObjects()
String	getProcessDefinitionCategory()
String	getProcessDefinitionId()
String	getProcessDefinitionIdLike()
String	getProcessDefinitionKey()
List<String>	getProcessDefinitionKeyIn()
String	getProcessDefinitionName()
Integer	getProcessDefinitionVersion()
String	getProcessInstanceId()
Set<String>	getProcessInstanceIds()
Integer	getProcessInstanceVariablesLimit()
List<String>	getProcessKeyNotIn()
static long	getSerialversionuid()
Date	getStartedAfter()
Date	getStartedBefore()
String	getStartedBy()
String	getSuperProcessInstanceId()
String	getTenantId()
String	getTenantIdLike()
HistoricProcessInstanceQuery	includeProcessVariables()	Include process variables in the process query result
HistoricProcessInstanceQuery	involvedGroupsIn(List<String> involvedGroups)	Only select the historic process instances with which the given groups are involved.
HistoricProcessInstanceQuery	involvedUser(String involvedUser)	Only select the historic process instances with which the user with the given id is involved.
boolean	isDeleted()
boolean	isExcludeSubprocesses()
boolean	isFinished()
boolean	isIncludeProcessVariables()
boolean	isNotDeleted()
boolean	isOpen()
boolean	isUnfinished()
boolean	isWithException()
boolean	isWithoutTenantId()
HistoricProcessInstanceQuery	limitProcessInstanceVariables(Integer processInstanceVariablesLimit)	Limit process instance variables
HistoricProcessInstanceQuery	locale(String locale)	Localize historic process name and description to specified locale.
protected void	localize(HistoricProcessInstance processInstance, CommandContext commandContext)
HistoricProcessInstanceQuery	notDeleted()	Only select historic process instance that are not deleted.
HistoricProcessInstanceQuery	or()	Begin an OR statement.
HistoricProcessInstanceQuery	orderByProcessDefinitionId()	Order by the process definition id (needs to be followed by Query.asc() or Query.desc()).
HistoricProcessInstanceQuery	orderByProcessInstanceBusinessKey()	Order by the business key (needs to be followed by Query.asc() or Query.desc()).
HistoricProcessInstanceQuery	orderByProcessInstanceDuration()	Order by the duration of the process instance (needs to be followed by Query.asc() or Query.desc()).
HistoricProcessInstanceQuery	orderByProcessInstanceEndTime()	Order by the end time (needs to be followed by Query.asc() or Query.desc()).
HistoricProcessInstanceQuery	orderByProcessInstanceId()	Order by the process instance id (needs to be followed by Query.asc() or Query.desc()).
HistoricProcessInstanceQuery	orderByProcessInstanceStartTime()	Order by the start time (needs to be followed by Query.asc() or Query.desc()).
HistoricProcessInstanceQuery	orderByTenantId()	Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
HistoricProcessInstanceQuery	processDefinitionCategory(String processDefinitionCategory)	Only select historic process instances whose process definition category is processDefinitionCategory.
HistoricProcessInstanceQueryImpl	processDefinitionId(String processDefinitionId)	Only select historic process instances for the given process definition
HistoricProcessInstanceQuery	processDefinitionKey(String processDefinitionKey)	Only select historic process instances that are defined by a process definition with the given key.
HistoricProcessInstanceQuery	processDefinitionKeyIn(List<String> processDefinitionKeys)	Only select historic process instances that are defined by a process definition with one of the given process definition keys.
HistoricProcessInstanceQuery	processDefinitionKeyNotIn(List<String> processDefinitionKeys)	Only select historic process instances that don't have a process-definition of which the key is present in the given list
HistoricProcessInstanceQuery	processDefinitionName(String processDefinitionName)	Select process historic instances whose process definition name is processDefinitionName
HistoricProcessInstanceQuery	processDefinitionVersion(Integer processDefinitionVersion)	Only select historic process instances with a certain process definition version.
HistoricProcessInstanceQuery	processInstanceBusinessKey(String businessKey)	Only select historic process instances with the given business key
HistoricProcessInstanceQueryImpl	processInstanceId(String processInstanceId)	Only select historic process instances with the given process instance.
HistoricProcessInstanceQuery	processInstanceIds(Set<String> processInstanceIds)	Only select historic process instances whose id is in the given set of ids.
HistoricProcessInstanceQuery	processInstanceName(String name)	Only select process instances with the given name.
HistoricProcessInstanceQuery	processInstanceNameLike(String nameLike)	Only select process instances with a name like the given value.
HistoricProcessInstanceQuery	processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)	Only select process instances with a name like the given value, ignoring upper/lower case.
HistoricProcessInstanceQuery	processInstanceTenantId(String tenantId)	Only select process instances that have the given tenant id.
HistoricProcessInstanceQuery	processInstanceTenantIdLike(String tenantIdLike)	Only select process instances with a tenant id like the given one.
HistoricProcessInstanceQuery	processInstanceWithoutTenantId()	Only select process instances that do not have a tenant id.
HistoricProcessInstanceQuery	startedAfter(Date startedAfter)	Only select historic process instances that were started after the given date.
HistoricProcessInstanceQuery	startedBefore(Date startedBefore)	Only select historic process instances that were started before the given date.
HistoricProcessInstanceQuery	startedBy(String startedBy)	Only select historic process instance that are started by the given user.
HistoricProcessInstanceQuery	superProcessInstanceId(String superProcessInstanceId)	Only select historic process instances started by the given process instance.
HistoricProcessInstanceQuery	unfinished()	Only select historic process instance that are not yet finished.
HistoricProcessInstanceQuery	variableValueEquals(Object variableValue)	Only select process instances which had at least one global variable with the given value when they ended.
HistoricProcessInstanceQuery	variableValueEquals(String variableName, Object variableValue)	Only select process instances which had a global variable with the given value when they ended.
HistoricProcessInstanceQuery	variableValueEqualsIgnoreCase(String name, String value)	Only select historic process instances which have a local string variable with the given value, case insensitive.
HistoricProcessInstanceQuery	variableValueGreaterThan(String name, Object value)	Only select process instances which had a global variable value greater than the passed value when they ended.
HistoricProcessInstanceQuery	variableValueGreaterThanOrEqual(String name, Object value)	Only select process instances which had a global variable value greater than or equal to the passed value when they ended.
HistoricProcessInstanceQuery	variableValueLessThan(String name, Object value)	Only select process instances which had a global variable value less than the passed value when the ended.
HistoricProcessInstanceQuery	variableValueLessThanOrEqual(String name, Object value)	Only select process instances which has a global variable value less than or equal to the passed value when they ended.
HistoricProcessInstanceQuery	variableValueLike(String name, String value)	Only select process instances which had global variable value like the given value when they ended.
HistoricProcessInstanceQuery	variableValueLikeIgnoreCase(String name, String value)	Only select process instances which had global variable value like (case insensitive) the given value when they ended.
HistoricProcessInstanceQuery	variableValueNotEquals(String variableName, Object variableValue)	Only select process instances which had a global variable with the given name, but with a different value than the passed value when they ended.
HistoricProcessInstanceQuery	variableValueNotEqualsIgnoreCase(String name, String value)
HistoricProcessInstanceQuery	withJobException()	Only select process instances that failed due to an exception happening during a job execution.
HistoricProcessInstanceQuery	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.activiti.engine.impl.AbstractVariableQueryImpl

addVariable, getQueryVariableValues, hasLocalQueryVariableValue, hasNonLocalQueryVariableValue, isBoolean, variableValueEquals, variableValueEquals, variableValueEqualsIgnoreCase, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueLikeIgnoreCase, variableValueNotEquals, variableValueNotEqualsIgnoreCase

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

addOrder, asc, count, desc, direction, execute, executeSingleResult, getDatabaseType, getOrderBy, getOrderByColumns, list, listPage, orderBy, orderBy, setCommandExecutor, setDatabaseType, singleResult

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

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

Methods inherited from class java.lang.Object

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

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

asc, count, desc, list, listPage, orderBy, singleResult

Field Details

processInstanceId

protected String processInstanceId

processDefinitionId

protected String processDefinitionId

businessKey

protected String businessKey

deploymentId

protected String deploymentId

deploymentIds

protected List<String> deploymentIds

finished

protected boolean finished

unfinished

protected boolean unfinished

deleted

protected boolean deleted

notDeleted

protected boolean notDeleted

startedBy

protected String startedBy

superProcessInstanceId

protected String superProcessInstanceId

excludeSubprocesses

protected boolean excludeSubprocesses

processDefinitionKeyIn

protected List<String> processDefinitionKeyIn

processKeyNotIn

protected List<String> processKeyNotIn

startedBefore

protected Date startedBefore

startedAfter

protected Date startedAfter

finishedBefore

protected Date finishedBefore

finishedAfter

protected Date finishedAfter

processDefinitionKey

protected String processDefinitionKey

processDefinitionCategory

protected String processDefinitionCategory

processDefinitionName

protected String processDefinitionName

processDefinitionVersion

protected Integer processDefinitionVersion

processInstanceIds

protected Set<String> processInstanceIds

involvedUser

protected String involvedUser

includeProcessVariables

protected boolean includeProcessVariables

processInstanceVariablesLimit

protected Integer processInstanceVariablesLimit

withJobException

protected boolean withJobException

tenantId

protected String tenantId

tenantIdLike

protected String tenantIdLike

withoutTenantId

protected boolean withoutTenantId

name

protected String name

nameLike

protected String nameLike

nameLikeIgnoreCase

protected String nameLikeIgnoreCase

locale

protected String locale

withLocalizationFallback

protected boolean withLocalizationFallback

orQueryObjects

protected List<HistoricProcessInstanceQueryImpl> orQueryObjects

currentOrQueryObject

protected HistoricProcessInstanceQueryImpl currentOrQueryObject

inOrStatement

protected boolean inOrStatement

involvedGroups

protected List<String> involvedGroups

Constructor Details

HistoricProcessInstanceQueryImpl

public HistoricProcessInstanceQueryImpl()

HistoricProcessInstanceQueryImpl

public HistoricProcessInstanceQueryImpl(CommandContext commandContext)

HistoricProcessInstanceQueryImpl

public HistoricProcessInstanceQueryImpl(CommandExecutor commandExecutor)

Method Details

processInstanceId

public HistoricProcessInstanceQueryImpl processInstanceId(String processInstanceId)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances with the given process instance. {@link ProcessInstance) ids and {@link HistoricProcessInstance} ids match.

Specified by:

processInstanceId in interface HistoricProcessInstanceQuery

processInstanceIds

public HistoricProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances whose id is in the given set of ids. {@link ProcessInstance) ids and {@link HistoricProcessInstance} ids match.

Specified by:

processInstanceIds in interface HistoricProcessInstanceQuery

processDefinitionId

public HistoricProcessInstanceQueryImpl processDefinitionId(String processDefinitionId)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances for the given process definition

Specified by:

processDefinitionId in interface HistoricProcessInstanceQuery

processDefinitionKey

public HistoricProcessInstanceQuery processDefinitionKey(String processDefinitionKey)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are defined by a process definition with the given key.

Specified by:

processDefinitionKey in interface HistoricProcessInstanceQuery

processDefinitionKeyIn

public HistoricProcessInstanceQuery processDefinitionKeyIn(List<String> processDefinitionKeys)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are defined by a process definition with one of the given process definition keys.

Specified by:

processDefinitionKeyIn in interface HistoricProcessInstanceQuery

processDefinitionCategory

public HistoricProcessInstanceQuery processDefinitionCategory(String processDefinitionCategory)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances whose process definition category is processDefinitionCategory.

Specified by:

processDefinitionCategory in interface HistoricProcessInstanceQuery

processDefinitionName

public HistoricProcessInstanceQuery processDefinitionName(String processDefinitionName)

Description copied from interface: HistoricProcessInstanceQuery

Select process historic instances whose process definition name is processDefinitionName

Specified by:

processDefinitionName in interface HistoricProcessInstanceQuery

processDefinitionVersion

public HistoricProcessInstanceQuery processDefinitionVersion(Integer processDefinitionVersion)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances with a certain process definition version. Particulary useful when used in combination with HistoricProcessInstanceQuery.processDefinitionKey(String)

Specified by:

processDefinitionVersion in interface HistoricProcessInstanceQuery

processInstanceBusinessKey

public HistoricProcessInstanceQuery processInstanceBusinessKey(String businessKey)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances with the given business key

Specified by:

processInstanceBusinessKey in interface HistoricProcessInstanceQuery

deploymentId

public HistoricProcessInstanceQuery deploymentId(String deploymentId)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are defined by a process definition with the given deployment identifier.

Specified by:

deploymentId in interface HistoricProcessInstanceQuery

deploymentIdIn

public HistoricProcessInstanceQuery deploymentIdIn(List<String> deploymentIds)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are defined by a process definition with one of the given deployment identifiers.

Specified by:

deploymentIdIn in interface HistoricProcessInstanceQuery

finished

public HistoricProcessInstanceQuery finished()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are completely finished.

Specified by:

finished in interface HistoricProcessInstanceQuery

unfinished

public HistoricProcessInstanceQuery unfinished()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instance that are not yet finished.

Specified by:

unfinished in interface HistoricProcessInstanceQuery

deleted

public HistoricProcessInstanceQuery deleted()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are deleted.

Specified by:

deleted in interface HistoricProcessInstanceQuery

notDeleted

public HistoricProcessInstanceQuery notDeleted()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instance that are not deleted.

Specified by:

notDeleted in interface HistoricProcessInstanceQuery

startedBy

public HistoricProcessInstanceQuery startedBy(String startedBy)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instance that are started by the given user.

Specified by:

startedBy in interface HistoricProcessInstanceQuery

processDefinitionKeyNotIn

public HistoricProcessInstanceQuery processDefinitionKeyNotIn(List<String> processDefinitionKeys)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that don't have a process-definition of which the key is present in the given list

Specified by:

processDefinitionKeyNotIn in interface HistoricProcessInstanceQuery

startedAfter

public HistoricProcessInstanceQuery startedAfter(Date startedAfter)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that were started after the given date.

Specified by:

startedAfter in interface HistoricProcessInstanceQuery

startedBefore

public HistoricProcessInstanceQuery startedBefore(Date startedBefore)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that were started before the given date.

Specified by:

startedBefore in interface HistoricProcessInstanceQuery

finishedAfter

public HistoricProcessInstanceQuery finishedAfter(Date finishedAfter)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that were started after the given date.

Specified by:

finishedAfter in interface HistoricProcessInstanceQuery

finishedBefore

public HistoricProcessInstanceQuery finishedBefore(Date finishedBefore)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that were started before the given date.

Specified by:

finishedBefore in interface HistoricProcessInstanceQuery

superProcessInstanceId

public HistoricProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances started by the given process instance. {@link ProcessInstance) ids and {@link HistoricProcessInstance} ids match.

Specified by:

superProcessInstanceId in interface HistoricProcessInstanceQuery

excludeSubprocesses

public HistoricProcessInstanceQuery excludeSubprocesses(boolean excludeSubprocesses)

Description copied from interface: HistoricProcessInstanceQuery

Exclude sub processes from the query result;

Specified by:

excludeSubprocesses in interface HistoricProcessInstanceQuery

involvedUser

public HistoricProcessInstanceQuery involvedUser(String involvedUser)

Description copied from interface: HistoricProcessInstanceQuery

Only select the historic process instances with which the user with the given id is involved.

Specified by:

involvedUser in interface HistoricProcessInstanceQuery

includeProcessVariables

public HistoricProcessInstanceQuery includeProcessVariables()

Description copied from interface: HistoricProcessInstanceQuery

Include process variables in the process query result

Specified by:

includeProcessVariables in interface HistoricProcessInstanceQuery

limitProcessInstanceVariables

public HistoricProcessInstanceQuery limitProcessInstanceVariables(Integer processInstanceVariablesLimit)

Description copied from interface: HistoricProcessInstanceQuery

Limit process instance variables

Specified by:

limitProcessInstanceVariables in interface HistoricProcessInstanceQuery

getProcessInstanceVariablesLimit

public Integer getProcessInstanceVariablesLimit()

withJobException

public HistoricProcessInstanceQuery withJobException()

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances that failed due to an exception happening during a job execution.

Specified by:

withJobException in interface HistoricProcessInstanceQuery

processInstanceTenantId

public HistoricProcessInstanceQuery processInstanceTenantId(String tenantId)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances that have the given tenant id.

Specified by:

processInstanceTenantId in interface HistoricProcessInstanceQuery

processInstanceTenantIdLike

public HistoricProcessInstanceQuery processInstanceTenantIdLike(String tenantIdLike)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances with a tenant id like the given one.

Specified by:

processInstanceTenantIdLike in interface HistoricProcessInstanceQuery

processInstanceWithoutTenantId

public HistoricProcessInstanceQuery processInstanceWithoutTenantId()

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances that do not have a tenant id.

Specified by:

processInstanceWithoutTenantId in interface HistoricProcessInstanceQuery

processInstanceName

public HistoricProcessInstanceQuery processInstanceName(String name)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances with the given name.

Specified by:

processInstanceName in interface HistoricProcessInstanceQuery

processInstanceNameLike

public HistoricProcessInstanceQuery processInstanceNameLike(String nameLike)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances with a name like the given value.

Specified by:

processInstanceNameLike in interface HistoricProcessInstanceQuery

processInstanceNameLikeIgnoreCase

public HistoricProcessInstanceQuery processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances with a name like the given value, ignoring upper/lower case.

Specified by:

processInstanceNameLikeIgnoreCase in interface HistoricProcessInstanceQuery

variableValueEquals

public HistoricProcessInstanceQuery variableValueEquals(String variableName,
 Object variableValue)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances which had a global variable with the given value when they ended. The type only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableTypes(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

variableValueEquals in interface HistoricProcessInstanceQuery

Overrides:

variableValueEquals in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

Parameters:

variableName - of the variable, cannot be null.

variableValueNotEquals

public HistoricProcessInstanceQuery variableValueNotEquals(String variableName,
 Object variableValue)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances which had a global variable with the given name, but with a different value than the passed value when they ended. Only select process instances which have a variable value greater than the passed value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

variableValueNotEquals in interface HistoricProcessInstanceQuery

Overrides:

variableValueNotEquals in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

Parameters:

variableName - of the variable, cannot be null.

variableValueEquals

public HistoricProcessInstanceQuery variableValueEquals(Object variableValue)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances which had at least one global variable with the given value when they ended. The type only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableTypes(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

variableValueEquals in interface HistoricProcessInstanceQuery

Overrides:

variableValueEquals in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

variableValueEqualsIgnoreCase

public HistoricProcessInstanceQuery variableValueEqualsIgnoreCase(String name,
 String value)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances which have a local string variable with the given value, case insensitive.

Specified by:

variableValueEqualsIgnoreCase in interface HistoricProcessInstanceQuery

Overrides:

variableValueEqualsIgnoreCase in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

Parameters:

name - name of the variable, cannot be null.

value - value of the variable, cannot be null.

variableValueNotEqualsIgnoreCase

public HistoricProcessInstanceQuery variableValueNotEqualsIgnoreCase(String name,
 String value)

Overrides:

variableValueNotEqualsIgnoreCase in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

variableValueGreaterThan

public HistoricProcessInstanceQuery variableValueGreaterThan(String name,
 Object value)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances which had a global variable value greater than the passed value when they ended. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported. Only select process instances which have a variable value greater than the passed value.

Specified by:

variableValueGreaterThan in interface HistoricProcessInstanceQuery

Overrides:

variableValueGreaterThan in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

Parameters:

name - cannot be null.

value - cannot be null.

variableValueGreaterThanOrEqual

public HistoricProcessInstanceQuery variableValueGreaterThanOrEqual(String name,
 Object value)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances which had a global variable value greater than or equal to the passed value when they ended. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead!

Specified by:

variableValueGreaterThanOrEqual in interface HistoricProcessInstanceQuery

Overrides:

variableValueGreaterThanOrEqual in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

Parameters:

name - cannot be null.

value - cannot be null.

variableValueLessThan

public HistoricProcessInstanceQuery variableValueLessThan(String name,
 Object value)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances which had a global variable value less than the passed value when the ended. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

variableValueLessThan in interface HistoricProcessInstanceQuery

Overrides:

variableValueLessThan in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

Parameters:

name - cannot be null.

value - cannot be null.

variableValueLessThanOrEqual

public HistoricProcessInstanceQuery variableValueLessThanOrEqual(String name,
 Object value)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances which has a global variable value less than or equal to the passed value when they ended. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Specified by:

variableValueLessThanOrEqual in interface HistoricProcessInstanceQuery

Overrides:

variableValueLessThanOrEqual in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

Parameters:

name - cannot be null.

value - cannot be null.

variableValueLike

public HistoricProcessInstanceQuery variableValueLike(String name,
 String value)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances which had global variable value like the given value when they ended. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! This can be used on string variables only.

Specified by:

variableValueLike in interface HistoricProcessInstanceQuery

Overrides:

variableValueLike in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

Parameters:

name - cannot be null.

value - cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).

locale

public HistoricProcessInstanceQuery locale(String locale)

Description copied from interface: HistoricProcessInstanceQuery

Localize historic process name and description to specified locale.

Specified by:

locale in interface HistoricProcessInstanceQuery

withLocalizationFallback

public HistoricProcessInstanceQuery withLocalizationFallback()

Description copied from interface: HistoricProcessInstanceQuery

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 interface HistoricProcessInstanceQuery

variableValueLikeIgnoreCase

public HistoricProcessInstanceQuery variableValueLikeIgnoreCase(String name,
 String value)

Description copied from interface: HistoricProcessInstanceQuery

Only select process instances which had global variable value like (case insensitive) the given value when they ended. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! This can be used on string variables only.

Specified by:

variableValueLikeIgnoreCase in interface HistoricProcessInstanceQuery

Overrides:

variableValueLikeIgnoreCase in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

Parameters:

name - cannot be null.

value - cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).

or

public HistoricProcessInstanceQuery or()

Description copied from interface: HistoricProcessInstanceQuery

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 interface HistoricProcessInstanceQuery

endOr

public HistoricProcessInstanceQuery endOr()

Description copied from interface: HistoricProcessInstanceQuery

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 interface HistoricProcessInstanceQuery

orderByProcessInstanceBusinessKey

public HistoricProcessInstanceQuery orderByProcessInstanceBusinessKey()

Description copied from interface: HistoricProcessInstanceQuery

Order by the business key (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByProcessInstanceBusinessKey in interface HistoricProcessInstanceQuery

orderByProcessInstanceDuration

public HistoricProcessInstanceQuery orderByProcessInstanceDuration()

Description copied from interface: HistoricProcessInstanceQuery

Order by the duration of the process instance (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByProcessInstanceDuration in interface HistoricProcessInstanceQuery

orderByProcessInstanceStartTime

public HistoricProcessInstanceQuery orderByProcessInstanceStartTime()

Description copied from interface: HistoricProcessInstanceQuery

Order by the start time (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByProcessInstanceStartTime in interface HistoricProcessInstanceQuery

orderByProcessInstanceEndTime

public HistoricProcessInstanceQuery orderByProcessInstanceEndTime()

Description copied from interface: HistoricProcessInstanceQuery

Order by the end time (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByProcessInstanceEndTime in interface HistoricProcessInstanceQuery

orderByProcessDefinitionId

public HistoricProcessInstanceQuery orderByProcessDefinitionId()

Description copied from interface: HistoricProcessInstanceQuery

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

Specified by:

orderByProcessDefinitionId in interface HistoricProcessInstanceQuery

orderByProcessInstanceId

public HistoricProcessInstanceQuery orderByProcessInstanceId()

Description copied from interface: HistoricProcessInstanceQuery

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

Specified by:

orderByProcessInstanceId in interface HistoricProcessInstanceQuery

orderByTenantId

public HistoricProcessInstanceQuery orderByTenantId()

Description copied from interface: HistoricProcessInstanceQuery

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

Specified by:

orderByTenantId in interface HistoricProcessInstanceQuery

getMssqlOrDB2OrderBy

public String getMssqlOrDB2OrderBy()

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

executeList

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

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

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

localize

protected void localize(HistoricProcessInstance processInstance,
 CommandContext commandContext)

ensureVariablesInitialized

protected void ensureVariablesInitialized()

Overrides:

ensureVariablesInitialized in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

checkQueryOk

protected void checkQueryOk()

Overrides:

checkQueryOk in class AbstractQuery<HistoricProcessInstanceQuery,HistoricProcessInstance>

getBusinessKey

public String getBusinessKey()

isOpen

public boolean isOpen()

getProcessDefinitionId

public String getProcessDefinitionId()

getProcessDefinitionKey

public String getProcessDefinitionKey()

getProcessDefinitionKeyIn

public List<String> getProcessDefinitionKeyIn()

getProcessDefinitionIdLike

public String getProcessDefinitionIdLike()

getProcessDefinitionName

public String getProcessDefinitionName()

getProcessDefinitionCategory

public String getProcessDefinitionCategory()

getProcessDefinitionVersion

public Integer getProcessDefinitionVersion()

getProcessInstanceId

public String getProcessInstanceId()

getProcessInstanceIds

public Set<String> getProcessInstanceIds()

getStartedBy

public String getStartedBy()

getSuperProcessInstanceId

public String getSuperProcessInstanceId()

isExcludeSubprocesses

public boolean isExcludeSubprocesses()

getProcessKeyNotIn

public List<String> getProcessKeyNotIn()

getStartedAfter

public Date getStartedAfter()

getStartedBefore

public Date getStartedBefore()

getFinishedAfter

public Date getFinishedAfter()

getFinishedBefore

public Date getFinishedBefore()

getInvolvedUser

public String getInvolvedUser()

getName

public String getName()

getNameLike

public String getNameLike()

getSerialversionuid

public static long getSerialversionuid()

getDeploymentId

public String getDeploymentId()

getDeploymentIds

public List<String> getDeploymentIds()

isFinished

public boolean isFinished()

isUnfinished

public boolean isUnfinished()

isDeleted

public boolean isDeleted()

isNotDeleted

public boolean isNotDeleted()

isIncludeProcessVariables

public boolean isIncludeProcessVariables()

isWithException

public boolean isWithException()

getTenantId

public String getTenantId()

getTenantIdLike

public String getTenantIdLike()

isWithoutTenantId

public boolean isWithoutTenantId()

getNameLikeIgnoreCase

public String getNameLikeIgnoreCase()

getOrQueryObjects

public List<HistoricProcessInstanceQueryImpl> getOrQueryObjects()

getInvolvedGroups

public List<String> getInvolvedGroups()

involvedGroupsIn

public HistoricProcessInstanceQuery involvedGroupsIn(List<String> involvedGroups)

Description copied from interface: HistoricProcessInstanceQuery

Only select the historic process instances with which the given groups are involved.

Specified by:

involvedGroupsIn in interface HistoricProcessInstanceQuery