Package org.camunda.bpm.engine.impl

Class HistoricProcessInstanceQueryImpl

java.lang.Object

org.camunda.bpm.engine.impl.db.ListQueryParameterObject

org.camunda.bpm.engine.impl.AbstractQuery<T,U>

org.camunda.bpm.engine.impl.AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

org.camunda.bpm.engine.impl.HistoricProcessInstanceQueryImpl

All Implemented Interfaces:

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

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

Author:

Tom Baeyens, Falko Menge, Bernd Ruecker

See Also:

• Serialized Form

Nested Class Summary

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

AbstractQuery.ResultType

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	activeActivityIds
protected String	businessKey
protected String[]	businessKeyIn
protected String	businessKeyLike
protected String	caseInstanceId
protected Date	executedActivityAfter
protected Date	executedActivityBefore
protected String[]	executedActivityIds
protected Date	executedJobAfter
protected Date	executedJobBefore
protected Date	finishDateBy
protected Date	finishDateOn
protected Date	finishDateOnBegin
protected Date	finishDateOnEnd
protected boolean	finished
protected Date	finishedAfter
protected Date	finishedBefore
protected String	incidentMessage
protected String	incidentMessageLike
protected String	incidentStatus
protected String	incidentType
protected boolean	isOrQueryActive
protected boolean	isRootProcessInstances
protected boolean	isTenantIdSet
protected String	processDefinitionId
protected String	processDefinitionKey
protected String[]	processDefinitionKeys
protected String	processDefinitionName
protected String	processDefinitionNameLike
protected String	processInstanceId
protected Set<String>	processInstanceIds
protected List<String>	processKeyNotIn
protected List<HistoricProcessInstanceQueryImpl>	queries
protected Map<String,Set<QueryVariableValue>>	queryVariableNameToValuesMap
protected Date	startDateBy
protected Date	startDateOn
protected Date	startDateOnBegin
protected Date	startDateOnEnd
protected Date	startedAfter
protected Date	startedBefore
protected String	startedBy
protected String	state
protected String	subCaseInstanceId
protected String	subProcessInstanceId
protected String	superCaseInstanceId
protected String	superProcessInstanceId
protected String[]	tenantIds
protected boolean	unfinished
protected boolean	withIncidents
protected boolean	withRootIncidents

Fields inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl

queryVariableValues, variableNamesIgnoreCase, variableValuesIgnoreCase

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

commandExecutor, expressions, maxResultsLimitEnabled, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck

Constructor Summary

Constructors

Constructor	Description
HistoricProcessInstanceQueryImpl()
HistoricProcessInstanceQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
HistoricProcessInstanceQuery	active()	Only select historic process instances that are active.
HistoricProcessInstanceQuery	activeActivityIdIn(String... ids)	Only select historic process instances that have active activities with given ids.
void	addOrQuery(HistoricProcessInstanceQueryImpl orQuery)
protected void	addVariable(String name, Object value, QueryOperator operator, boolean processInstanceScope)
HistoricProcessInstanceQuery	caseInstanceId(String caseInstanceId)	Only select historic process instances which are associated with the given case instance id.
HistoricProcessInstanceQuery	completed()	Only select historic process instances that are completed.
HistoricProcessInstanceQuery	endOr()	endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied.
protected void	ensureVariablesInitialized()
long	executeCount(CommandContext commandContext)
HistoricProcessInstanceQuery	executedActivityAfter(Date date)	Only select historic process instances that executed an activity after the given date.
HistoricProcessInstanceQuery	executedActivityBefore(Date date)	Only select historic process instances that executed an activity before the given date.
HistoricProcessInstanceQuery	executedActivityIdIn(String... ids)	Only select historic process instances that executed activities with given ids.
List<ImmutablePair<String,String>>	executeDeploymentIdMappingsList(CommandContext commandContext)
HistoricProcessInstanceQuery	executedJobAfter(Date date)	Only select historic process instances that executed an job after the given date.
HistoricProcessInstanceQuery	executedJobBefore(Date date)	Only select historic process instances that executed an job before the given date.
List<String>	executeIdsList(CommandContext commandContext)
List<HistoricProcessInstance>	executeList(CommandContext commandContext, Page page)	Executes the actual query to retrieve the list of results.
HistoricProcessInstanceQuery	externallyTerminated()	Only select historic process instances that are externallyTerminated.
HistoricProcessInstanceQuery	finishDateBy(Date date)	Deprecated.
HistoricProcessInstanceQuery	finishDateOn(Date date)	Deprecated.
HistoricProcessInstanceQuery	finished()	Only select historic process instances that are completely finished.
HistoricProcessInstanceQuery	finishedAfter(Date date)	Only select historic process instances that were started after the given date.
HistoricProcessInstanceQuery	finishedBefore(Date date)	Only select historic process instances that were started before the given date.
String[]	getActiveActivityIds()
String	getBusinessKey()
String[]	getBusinessKeyIn()
String	getBusinessKeyLike()
String	getCaseInstanceId()
Date	getExecutedActivityAfter()
Date	getExecutedActivityBefore()
String[]	getExecutedActivityIds()
Date	getExecutedJobAfter()
Date	getExecutedJobBefore()
Date	getFinishDateBy()
Date	getFinishDateOn()
Date	getFinishDateOnBegin()
Date	getFinishDateOnEnd()
Date	getFinishedAfter()
Date	getFinishedBefore()
String	getIncidentMessage()
String	getIncidentMessageLike()
String	getIncidentStatus()
String	getIncidentType()
boolean	getIsTenantIdSet()
String	getProcessDefinitionId()
String	getProcessDefinitionIdLike()
String	getProcessDefinitionKey()
String[]	getProcessDefinitionKeys()
String	getProcessDefinitionName()
String	getProcessDefinitionNameLike()
String	getProcessInstanceId()
Set<String>	getProcessInstanceIds()
List<String>	getProcessKeyNotIn()
List<HistoricProcessInstanceQueryImpl>	getQueries()
Map<String,Set<QueryVariableValue>>	getQueryVariableNameToValuesMap()
List<QueryVariableValue>	getQueryVariableValues()
Date	getStartDateBy()
Date	getStartDateOn()
Date	getStartDateOnBegin()
Date	getStartDateOnEnd()
Date	getStartedAfter()
Date	getStartedBefore()
String	getStartedBy()
String	getState()
String	getSubCaseInstanceId()
String	getSubProcessInstanceId()
String	getSuperCaseInstanceId()
String	getSuperProcessInstanceId()
String[]	getTenantIds()
protected boolean	hasExcludingConditions()	Whether or not the query has excluding conditions.
HistoricProcessInstanceQuery	incidentMessage(String incidentMessage)	Only select historic process instances with the given incident message.
HistoricProcessInstanceQuery	incidentMessageLike(String incidentMessageLike)	Only select historic process instances which had an incident message like the given value.
HistoricProcessInstanceQuery	incidentStatus(String status)	Only select historic process instances with incident status either 'open' or 'resolved'.
HistoricProcessInstanceQuery	incidentType(String incidentType)	Only selects process instances with the given incident type.
HistoricProcessInstanceQuery	internallyTerminated()	Only select historic process instances that are internallyTerminated.
boolean	isFinished()
boolean	isOpen()
boolean	isOrQueryActive()
boolean	isRootProcessInstances()
boolean	isTenantIdSet()
boolean	isUnfinished()
boolean	isWithIncidents()
boolean	isWithRootIncidents()
HistoricProcessInstanceQuery	or()	After calling or(), a chain of several filter criteria could follow.
HistoricProcessInstanceQuery	orderByProcessDefinitionId()	Order by the process definition id (needs to be followed by Query.asc() or Query.desc()).
HistoricProcessInstanceQuery	orderByProcessDefinitionKey()	Order by the process definition key (needs to be followed by Query.asc() or Query.desc()).
HistoricProcessInstanceQuery	orderByProcessDefinitionName()	Order by the process definition name (needs to be followed by Query.asc() or Query.desc()).
HistoricProcessInstanceQuery	orderByProcessDefinitionVersion()	Order by the process definition version (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()).
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(String... processDefinitionKeys)	Only select historic process instances that are defined by any given process definition key.
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)	Only select historic process instances that are defined by a process definition with the given name.
HistoricProcessInstanceQuery	processDefinitionNameLike(String nameLike)	Only select historic process instances that are defined by process definition which name is like the given value.
HistoricProcessInstanceQuery	processInstanceBusinessKey(String businessKey)	Only select historic process instances with the given business key
HistoricProcessInstanceQuery	processInstanceBusinessKeyIn(String... businessKeyIn)	Only select historic process instances whose business key is in the given set.
HistoricProcessInstanceQuery	processInstanceBusinessKeyLike(String businessKeyLike)	Only select historic process instances which had a business key like the given value.
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	rootProcessInstances()	Only select historic process instances that are top level process instances.
void	setOrQueryActive()
void	setSuperProcessInstanceId(String superProcessInstanceId)
HistoricProcessInstanceQuery	startDateBy(Date date)	Deprecated.
HistoricProcessInstanceQuery	startDateOn(Date date)	Deprecated.
HistoricProcessInstanceQuery	startedAfter(Date date)	Only select historic process instances that were started after the given date.
HistoricProcessInstanceQuery	startedBefore(Date date)	Only select historic process instances that were started before the given date.
HistoricProcessInstanceQuery	startedBy(String userId)	Only select historic process instance that are started by the given user.
HistoricProcessInstanceQuery	subCaseInstanceId(String subCaseInstanceId)	Only select historic process instances having a sub case instance with the given case instance id.
HistoricProcessInstanceQuery	subProcessInstanceId(String subProcessInstanceId)	Only select historic process instances having a sub process instance with the given process instance id.
HistoricProcessInstanceQuery	superCaseInstanceId(String superCaseInstanceId)	Only select historic process instances started by the given case instance.
HistoricProcessInstanceQuery	superProcessInstanceId(String superProcessInstanceId)	Only select historic process instances started by the given process instance.
HistoricProcessInstanceQuery	suspended()	Only select historic process instances that are suspended.
HistoricProcessInstanceQuery	tenantIdIn(String... tenantIds)	Only select historic process instances with one of the given tenant ids.
HistoricProcessInstanceQuery	unfinished()	Only select historic process instance that are not yet finished.
HistoricProcessInstanceQuery	withIncidents()	Only select historic process instances with incidents
HistoricProcessInstanceQuery	withoutTenantId()	Only selects historic process instances which have no tenant id.
HistoricProcessInstanceQuery	withRootIncidents()	Only select historic process instances with root incidents

Methods inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl

createQueryVariableValue, isVariableNamesIgnoreCase, isVariableValuesIgnoreCase, matchVariableNamesIgnoreCase, matchVariableValuesIgnoreCase, validateVariable, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals, variableValueNotLike

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

addExpression, addValidator, asc, checkMaxResultsLimit, checkQueryOk, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteDeploymentIdMappingsList, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeResult, executeSingleResult, extend, getExpressions, getMethod, list, listDeploymentIdMappings, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unlimitedList, validate, validate

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.camunda.bpm.engine.impl.interceptor.Command

isRetryable

Methods inherited from interface org.camunda.bpm.engine.history.HistoricProcessInstanceQuery

matchVariableNamesIgnoreCase, matchVariableValuesIgnoreCase, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals

Methods inherited from interface org.camunda.bpm.engine.query.Query

asc, count, desc, list, listPage, singleResult, unlimitedList

Field Details

processInstanceId

protected String processInstanceId

processDefinitionId

protected String processDefinitionId

processDefinitionName

protected String processDefinitionName

processDefinitionNameLike

protected String processDefinitionNameLike

businessKey

protected String businessKey

businessKeyIn

protected String[] businessKeyIn

businessKeyLike

protected String businessKeyLike

finished

protected boolean finished

unfinished

protected boolean unfinished

withIncidents

protected boolean withIncidents

withRootIncidents

protected boolean withRootIncidents

incidentType

protected String incidentType

incidentStatus

protected String incidentStatus

incidentMessage

protected String incidentMessage

incidentMessageLike

protected String incidentMessageLike

startedBy

protected String startedBy

isRootProcessInstances

protected boolean isRootProcessInstances

superProcessInstanceId

protected String superProcessInstanceId

subProcessInstanceId

protected String subProcessInstanceId

superCaseInstanceId

protected String superCaseInstanceId

subCaseInstanceId

protected String subCaseInstanceId

processKeyNotIn

protected List<String> processKeyNotIn

startedBefore

protected Date startedBefore

startedAfter

protected Date startedAfter

finishedBefore

protected Date finishedBefore

finishedAfter

protected Date finishedAfter

executedActivityAfter

protected Date executedActivityAfter

executedActivityBefore

protected Date executedActivityBefore

executedJobAfter

protected Date executedJobAfter

executedJobBefore

protected Date executedJobBefore

processDefinitionKey

protected String processDefinitionKey

processDefinitionKeys

protected String[] processDefinitionKeys

processInstanceIds

protected Set<String> processInstanceIds

tenantIds

protected String[] tenantIds

isTenantIdSet

protected boolean isTenantIdSet

executedActivityIds

protected String[] executedActivityIds

activeActivityIds

protected String[] activeActivityIds

state

protected String state

caseInstanceId

protected String caseInstanceId

queries

protected List<HistoricProcessInstanceQueryImpl> queries

isOrQueryActive

protected boolean isOrQueryActive

queryVariableNameToValuesMap

protected Map<String,Set<QueryVariableValue>> queryVariableNameToValuesMap

startDateBy

protected Date startDateBy

startDateOn

protected Date startDateOn

finishDateBy

protected Date finishDateBy

finishDateOn

protected Date finishDateOn

startDateOnBegin

protected Date startDateOnBegin

startDateOnEnd

protected Date startDateOnEnd

finishDateOnBegin

protected Date finishDateOnBegin

finishDateOnEnd

protected Date finishDateOnEnd

Constructor Details

HistoricProcessInstanceQueryImpl

public HistoricProcessInstanceQueryImpl()

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(String... processDefinitionKeys)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are defined by any given process definition key.

Specified by:

processDefinitionKeyIn in interface HistoricProcessInstanceQuery

processDefinitionName

public HistoricProcessInstanceQuery processDefinitionName(String processDefinitionName)

Description copied from interface: HistoricProcessInstanceQuery

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

Specified by:

processDefinitionName in interface HistoricProcessInstanceQuery

processDefinitionNameLike

public HistoricProcessInstanceQuery processDefinitionNameLike(String nameLike)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are defined by process definition which name is like the given value.

Specified by:

processDefinitionNameLike in interface HistoricProcessInstanceQuery

Parameters:

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

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

processInstanceBusinessKeyIn

public HistoricProcessInstanceQuery processInstanceBusinessKeyIn(String... businessKeyIn)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances whose business key is in the given set.

Specified by:

processInstanceBusinessKeyIn in interface HistoricProcessInstanceQuery

processInstanceBusinessKeyLike

public HistoricProcessInstanceQuery processInstanceBusinessKeyLike(String businessKeyLike)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances which had a business key like the given value.

Specified by:

processInstanceBusinessKeyLike in interface HistoricProcessInstanceQuery

Parameters:

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

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

withIncidents

public HistoricProcessInstanceQuery withIncidents()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances with incidents

Specified by:

withIncidents in interface HistoricProcessInstanceQuery

Returns:

HistoricProcessInstanceQuery

withRootIncidents

public HistoricProcessInstanceQuery withRootIncidents()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances with root incidents

Specified by:

withRootIncidents in interface HistoricProcessInstanceQuery

Returns:

HistoricProcessInstanceQuery

incidentType

public HistoricProcessInstanceQuery incidentType(String incidentType)

Description copied from interface: HistoricProcessInstanceQuery

Only selects process instances with the given incident type.

Specified by:

incidentType in interface HistoricProcessInstanceQuery

incidentStatus

public HistoricProcessInstanceQuery incidentStatus(String status)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances with incident status either 'open' or 'resolved'. To get all process instances with incidents, use HistoricProcessInstanceQuery.withIncidents().

Specified by:

incidentStatus in interface HistoricProcessInstanceQuery

Parameters:

status - indicates the incident status, which is either 'open' or 'resolved'

Returns:

HistoricProcessInstanceQuery

incidentMessage

public HistoricProcessInstanceQuery incidentMessage(String incidentMessage)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances with the given incident message.

Specified by:

incidentMessage in interface HistoricProcessInstanceQuery

Parameters:

incidentMessage - Incidents Message for which the historic process instances should be selected

Returns:

HistoricProcessInstanceQuery

incidentMessageLike

public HistoricProcessInstanceQuery incidentMessageLike(String incidentMessageLike)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances which had an incident message like the given value.

Specified by:

incidentMessageLike in interface HistoricProcessInstanceQuery

Parameters:

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

Returns:

HistoricProcessInstanceQuery

startedBy

public HistoricProcessInstanceQuery startedBy(String userId)

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 date)

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 date)

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 date)

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 date)

Description copied from interface: HistoricProcessInstanceQuery

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

Specified by:

finishedBefore in interface HistoricProcessInstanceQuery

rootProcessInstances

public HistoricProcessInstanceQuery rootProcessInstances()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are top level process instances.

Specified by:

rootProcessInstances 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

subProcessInstanceId

public HistoricProcessInstanceQuery subProcessInstanceId(String subProcessInstanceId)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances having a sub process instance with the given process instance id.

Note that there will always be maximum only one such process instance that can be the result of this query.

Specified by:

subProcessInstanceId in interface HistoricProcessInstanceQuery

superCaseInstanceId

public HistoricProcessInstanceQuery superCaseInstanceId(String superCaseInstanceId)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances started by the given case instance.

Specified by:

superCaseInstanceId in interface HistoricProcessInstanceQuery

subCaseInstanceId

public HistoricProcessInstanceQuery subCaseInstanceId(String subCaseInstanceId)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances having a sub case instance with the given case instance id.

Note that there will always be maximum only one such process instance that can be the result of this query.

Specified by:

subCaseInstanceId in interface HistoricProcessInstanceQuery

caseInstanceId

public HistoricProcessInstanceQuery caseInstanceId(String caseInstanceId)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances which are associated with the given case instance id.

Specified by:

caseInstanceId in interface HistoricProcessInstanceQuery

tenantIdIn

public HistoricProcessInstanceQuery tenantIdIn(String... tenantIds)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances with one of the given tenant ids.

Specified by:

tenantIdIn in interface HistoricProcessInstanceQuery

withoutTenantId

public HistoricProcessInstanceQuery withoutTenantId()

Description copied from interface: HistoricProcessInstanceQuery

Only selects historic process instances which have no tenant id.

Specified by:

withoutTenantId in interface HistoricProcessInstanceQuery

hasExcludingConditions

protected boolean hasExcludingConditions()

Description copied from class: AbstractQuery

Whether or not the query has excluding conditions. If the query has excluding conditions, (e.g. task due date before and after are excluding), the SQL query is avoided and a default result is returned. The returned result is the same as if the SQL was executed and there were no entries.

Overrides:

hasExcludingConditions in class AbstractQuery<HistoricProcessInstanceQuery,HistoricProcessInstance>

Returns:

true if the query does have excluding conditions, false otherwise

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

orderByProcessDefinitionKey

public HistoricProcessInstanceQuery orderByProcessDefinitionKey()

Description copied from interface: HistoricProcessInstanceQuery

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

Specified by:

orderByProcessDefinitionKey in interface HistoricProcessInstanceQuery

orderByProcessDefinitionName

public HistoricProcessInstanceQuery orderByProcessDefinitionName()

Description copied from interface: HistoricProcessInstanceQuery

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

Specified by:

orderByProcessDefinitionName in interface HistoricProcessInstanceQuery

orderByProcessDefinitionVersion

public HistoricProcessInstanceQuery orderByProcessDefinitionVersion()

Description copied from interface: HistoricProcessInstanceQuery

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

Specified by:

orderByProcessDefinitionVersion 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()). Note that the ordering of historic process instances without tenant id is database-specific.

Specified by:

orderByTenantId in interface HistoricProcessInstanceQuery

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.

executeIdsList

public List<String> executeIdsList(CommandContext commandContext)

Overrides:

executeIdsList in class AbstractQuery<HistoricProcessInstanceQuery,HistoricProcessInstance>

executeDeploymentIdMappingsList

public List<ImmutablePair<String,String>> executeDeploymentIdMappingsList(CommandContext commandContext)

Overrides:

executeDeploymentIdMappingsList in class AbstractQuery<HistoricProcessInstanceQuery,HistoricProcessInstance>

getQueryVariableValues

public List<QueryVariableValue> getQueryVariableValues()

Overrides:

getQueryVariableValues in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

getQueryVariableNameToValuesMap

public Map<String,Set<QueryVariableValue>> getQueryVariableNameToValuesMap()

ensureVariablesInitialized

protected void ensureVariablesInitialized()

Overrides:

ensureVariablesInitialized in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

addVariable

protected void addVariable(String name,
 Object value,
 QueryOperator operator,
 boolean processInstanceScope)

Overrides:

addVariable in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>

getQueries

public List<HistoricProcessInstanceQueryImpl> getQueries()

addOrQuery

public void addOrQuery(HistoricProcessInstanceQueryImpl orQuery)

setOrQueryActive

public void setOrQueryActive()

isOrQueryActive

public boolean isOrQueryActive()

getActiveActivityIds

public String[] getActiveActivityIds()

getBusinessKey

public String getBusinessKey()

getBusinessKeyIn

public String[] getBusinessKeyIn()

getBusinessKeyLike

public String getBusinessKeyLike()

getExecutedActivityIds

public String[] getExecutedActivityIds()

getExecutedActivityAfter

public Date getExecutedActivityAfter()

getExecutedActivityBefore

public Date getExecutedActivityBefore()

getExecutedJobAfter

public Date getExecutedJobAfter()

getExecutedJobBefore

public Date getExecutedJobBefore()

isOpen

public boolean isOpen()

isUnfinished

public boolean isUnfinished()

isFinished

public boolean isFinished()

getProcessDefinitionId

public String getProcessDefinitionId()

getProcessDefinitionKey

public String getProcessDefinitionKey()

getProcessDefinitionKeys

public String[] getProcessDefinitionKeys()

getProcessDefinitionIdLike

public String getProcessDefinitionIdLike()

getProcessDefinitionName

public String getProcessDefinitionName()

getProcessDefinitionNameLike

public String getProcessDefinitionNameLike()

getProcessInstanceId

public String getProcessInstanceId()

getProcessInstanceIds

public Set<String> getProcessInstanceIds()

getStartedBy

public String getStartedBy()

getSuperProcessInstanceId

public String getSuperProcessInstanceId()

setSuperProcessInstanceId

public void setSuperProcessInstanceId(String superProcessInstanceId)

getProcessKeyNotIn

public List<String> getProcessKeyNotIn()

getStartedAfter

public Date getStartedAfter()

getStartedBefore

public Date getStartedBefore()

getFinishedAfter

public Date getFinishedAfter()

getFinishedBefore

public Date getFinishedBefore()

getCaseInstanceId

public String getCaseInstanceId()

getIncidentType

public String getIncidentType()

getIncidentMessage

public String getIncidentMessage()

getIncidentMessageLike

public String getIncidentMessageLike()

getIncidentStatus

public String getIncidentStatus()

getState

public String getState()

getFinishDateBy

public Date getFinishDateBy()

getStartDateBy

public Date getStartDateBy()

getStartDateOn

public Date getStartDateOn()

getStartDateOnBegin

public Date getStartDateOnBegin()

getStartDateOnEnd

public Date getStartDateOnEnd()

getFinishDateOn

public Date getFinishDateOn()

getFinishDateOnBegin

public Date getFinishDateOnBegin()

getFinishDateOnEnd

public Date getFinishDateOnEnd()

isTenantIdSet

public boolean isTenantIdSet()

getIsTenantIdSet

public boolean getIsTenantIdSet()

isWithIncidents

public boolean isWithIncidents()

isWithRootIncidents

public boolean isWithRootIncidents()

startDateBy

@Deprecated
public HistoricProcessInstanceQuery startDateBy(Date date)

Deprecated.

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that were started as of the provided date. (Date will be adjusted to reflect midnight)

Specified by:

startDateBy in interface HistoricProcessInstanceQuery

startDateOn

@Deprecated
public HistoricProcessInstanceQuery startDateOn(Date date)

Deprecated.

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that were started on the provided date.

Specified by:

startDateOn in interface HistoricProcessInstanceQuery

finishDateBy

@Deprecated
public HistoricProcessInstanceQuery finishDateBy(Date date)

Deprecated.

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that were finished as of the provided date. (Date will be adjusted to reflect one second before midnight)

Specified by:

finishDateBy in interface HistoricProcessInstanceQuery

finishDateOn

@Deprecated
public HistoricProcessInstanceQuery finishDateOn(Date date)

Deprecated.

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that were finished on provided date.

Specified by:

finishDateOn in interface HistoricProcessInstanceQuery

isRootProcessInstances

public boolean isRootProcessInstances()

getSubProcessInstanceId

public String getSubProcessInstanceId()

getSuperCaseInstanceId

public String getSuperCaseInstanceId()

getSubCaseInstanceId

public String getSubCaseInstanceId()

getTenantIds

public String[] getTenantIds()

executedActivityAfter

public HistoricProcessInstanceQuery executedActivityAfter(Date date)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that executed an activity after the given date.

Specified by:

executedActivityAfter in interface HistoricProcessInstanceQuery

executedActivityBefore

public HistoricProcessInstanceQuery executedActivityBefore(Date date)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that executed an activity before the given date.

Specified by:

executedActivityBefore in interface HistoricProcessInstanceQuery

executedJobAfter

public HistoricProcessInstanceQuery executedJobAfter(Date date)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that executed an job after the given date.

Specified by:

executedJobAfter in interface HistoricProcessInstanceQuery

executedJobBefore

public HistoricProcessInstanceQuery executedJobBefore(Date date)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that executed an job before the given date.

Specified by:

executedJobBefore in interface HistoricProcessInstanceQuery

executedActivityIdIn

public HistoricProcessInstanceQuery executedActivityIdIn(String... ids)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that executed activities with given ids.

Specified by:

executedActivityIdIn in interface HistoricProcessInstanceQuery

activeActivityIdIn

public HistoricProcessInstanceQuery activeActivityIdIn(String... ids)

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that have active activities with given ids.

Specified by:

activeActivityIdIn in interface HistoricProcessInstanceQuery

active

public HistoricProcessInstanceQuery active()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are active.

Specified by:

active in interface HistoricProcessInstanceQuery

suspended

public HistoricProcessInstanceQuery suspended()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are suspended.

Specified by:

suspended in interface HistoricProcessInstanceQuery

completed

public HistoricProcessInstanceQuery completed()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are completed.

Specified by:

completed in interface HistoricProcessInstanceQuery

externallyTerminated

public HistoricProcessInstanceQuery externallyTerminated()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are externallyTerminated.

Specified by:

externallyTerminated in interface HistoricProcessInstanceQuery

internallyTerminated

public HistoricProcessInstanceQuery internallyTerminated()

Description copied from interface: HistoricProcessInstanceQuery

Only select historic process instances that are internallyTerminated.

Specified by:

internallyTerminated in interface HistoricProcessInstanceQuery

or

public HistoricProcessInstanceQuery or()

Description copied from interface: HistoricProcessInstanceQuery

After calling or(), a chain of several filter criteria could follow. Each filter criterion that follows or() will be linked together with an OR expression until the OR query is terminated. To terminate the OR query right after the last filter criterion was applied, HistoricProcessInstanceQuery.endOr() must be invoked.

Specified by:

or in interface HistoricProcessInstanceQuery

Returns:

an object of the type HistoricProcessInstanceQuery on which an arbitrary amount of filter criteria could be applied. The several filter criteria will be linked together by an OR expression.

endOr

public HistoricProcessInstanceQuery endOr()

Description copied from interface: HistoricProcessInstanceQuery

endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied. To terminate the OR query which has been started by invoking HistoricProcessInstanceQuery.or(), endOr() must be invoked. Filter criteria which are applied after calling endOr() are linked together by an AND expression.

Specified by:

endOr in interface HistoricProcessInstanceQuery

Returns:

an object of the type HistoricProcessInstanceQuery on which an arbitrary amount of filter criteria could be applied. The filter criteria will be linked together by an AND expression.