| Package | Description | 
|---|---|
| org.activiti.engine | 
 Public API of the Activiti engine. 
Typical usage of the API starts by the creation of a ProcessEngineConfiguration
    (typically based on a configuration file), from which a ProcessEngine can be obtained.Through the services obtained from such a ProcessEngine, BPM and workflow operation 
    can be executed:RepositoryService:  Manages Deployments RuntimeService:  For starting and searching ProcessInstances TaskService:  Exposes operations to manage human (standalone) Tasks, 
    such as claiming, completing and assigning tasksIdentityService:  Used for managing Users, 
    Groups and the relations between themManagementService:  Exposes engine admin and maintenance operations,
    which have no relation to the runtime exection of business processesHistoryService:  Exposes information about ongoing and past process instances.FormService:  Access to form data and rendered forms for starting new process instances and completing tasks. | 
| org.activiti.engine.history | 
 Classes related to the  
HistoryService. | 
| Modifier and Type | Method and Description | 
|---|---|
HistoricProcessInstanceQuery | 
HistoryService.createHistoricProcessInstanceQuery()
Creates a new programmatic query to search for  
HistoricProcessInstances. | 
| Modifier and Type | Method and Description | 
|---|---|
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.deleted()
Only select historic process instances that are deleted. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.deploymentId(String deploymentId)
Only select historic process instances that are defined by a process
 definition with the given deployment identifier. 
 | 
HistoricProcessInstanceQuery | 
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 | 
HistoricProcessInstanceQuery.endOr()
End an OR statement. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.excludeSubprocesses(boolean excludeSubprocesses)
Exclude sub processes from the query result; 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.finished()
Only select historic process instances that are completely finished. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.finishedAfter(Date date)
Only select historic process instances that were started after the given date. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.finishedBefore(Date date)
Only select historic process instances that were started before the given date. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.includeProcessVariables()
Include process variables in the process query result 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.involvedUser(String userId)
Only select the historic process instances with which the user with the given id is involved. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.limitProcessInstanceVariables(Integer processInstanceVariablesLimit)
Limit process instance variables 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.locale(String locale)
Localize historic process name and description to specified locale. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.notDeleted()
Only select historic process instance that are not deleted. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.or()
Begin an OR statement. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.orderByProcessDefinitionId()
Order by the process definition id (needs to be followed by  
Query.asc() or Query.desc()). | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.orderByProcessInstanceBusinessKey()
Order by the business key (needs to be followed by  
Query.asc() or Query.desc()). | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.orderByProcessInstanceDuration()
Order by the duration of the process instance (needs to be followed by  
Query.asc() or Query.desc()). | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.orderByProcessInstanceEndTime()
Order by the end time (needs to be followed by  
Query.asc() or Query.desc()). | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.orderByProcessInstanceId()
Order by the process instance id (needs to be followed by  
Query.asc() or Query.desc()). | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.orderByProcessInstanceStartTime()
Order by the start time (needs to be followed by  
Query.asc() or Query.desc()). | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.orderByTenantId()
Order by tenant id (needs to be followed by  
Query.asc() or Query.desc()). | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processDefinitionCategory(String processDefinitionCategory)
Only select historic process instances whose process definition category is processDefinitionCategory. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processDefinitionId(String processDefinitionId)
Only select historic process instances for the given process definition 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processDefinitionKey(String processDefinitionKey)
Only select historic process instances that are defined by a process
 definition with the given key. 
 | 
HistoricProcessInstanceQuery | 
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 | 
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 | 
HistoricProcessInstanceQuery.processDefinitionName(String processDefinitionName)
Select process historic instances whose process definition name is processDefinitionName 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processDefinitionVersion(Integer processDefinitionVersion)
Only select historic process instances with a certain process definition version. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processInstanceBusinessKey(String processInstanceBusinessKey)
Only select historic process instances with the given business key 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processInstanceId(String processInstanceId)
Only select historic process instances with the given process instance. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processInstanceIds(Set<String> processInstanceIds)
Only select historic process instances whose id is in the given set of ids. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processInstanceName(String name)
Only select process instances with the given name. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processInstanceNameLike(String nameLike)
Only select process instances with a name like the given value. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)
Only select process instances with a name like the given value, ignoring upper/lower case. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processInstanceTenantId(String tenantId)
Only select process instances that have the given tenant id. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processInstanceTenantIdLike(String tenantIdLike)
Only select process instances with a tenant id like the given one. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.processInstanceWithoutTenantId()
Only select process instances that do not have a tenant id. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.startedAfter(Date date)
Only select historic process instances that were started after the given date. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.startedBefore(Date date)
Only select historic process instances that were started before the given date. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.startedBy(String userId)
Only select historic process instance that are started by the given user. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.superProcessInstanceId(String superProcessInstanceId)
Only select historic process instances started by the given process
 instance. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.unfinished()
Only select historic process instance that are not yet finished. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.variableValueEquals(Object value)
Only select process instances which had at least one global variable with the given value
 when they ended. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.variableValueEquals(String name,
                   Object value)
Only select process instances which had a global variable with the given value
 when they ended. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.variableValueEqualsIgnoreCase(String name,
                             String value)
Only select historic process instances which have a local string variable with the 
 given value, case insensitive. 
 | 
HistoricProcessInstanceQuery | 
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 | 
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 | 
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 | 
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 | 
HistoricProcessInstanceQuery.variableValueLike(String name,
                 String value)
Only select process instances which had global variable value like the given value
 when they ended. 
 | 
HistoricProcessInstanceQuery | 
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 | 
HistoricProcessInstanceQuery.variableValueNotEquals(String name,
                      Object value)
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 | 
HistoricProcessInstanceQuery.withJobException()
Only select process instances that failed due to an exception happening during a job execution. 
 | 
HistoricProcessInstanceQuery | 
HistoricProcessInstanceQuery.withLocalizationFallback()
Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found. 
 | 
Copyright © 2017 Flowable. All rights reserved.