Package | Description |
---|---|
org.camunda.bpm.engine |
Public API of the Camunda Platform 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 Deployment sRuntimeService :
For starting and searching ProcessInstance sTaskService :
Exposes operations to manage human (standalone) Task s,
such as claiming, completing and assigning tasksIdentityService :
Used for managing User s,
Group s and the relations between themManagementService :
Exposes engine admin and maintenance operations,
which have no relation to the runtime execution 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.camunda.bpm.engine.history |
Classes related to the
HistoryService . |
org.camunda.bpm.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
org.camunda.bpm.engine.rest.dto.history |
Modifier and Type | Method and Description |
---|---|
HistoricCaseInstanceQuery |
HistoryService.createHistoricCaseInstanceQuery()
Creates a new programmatic query to search for
HistoricCaseInstance s. |
Modifier and Type | Method and Description |
---|---|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.active()
Only select historic case instances which are active
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.caseActivityIdIn(String... caseActivityIds)
Only selects historic case instances with historic case activity instances
in at least one of the given case activity ids.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.caseDefinitionId(String caseDefinitionId)
Only select historic case instances for the given case definition
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.caseDefinitionKey(String caseDefinitionKey)
Only select historic case instances that are defined by a case definition with the given key.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.caseDefinitionKeyNotIn(List<String> caseDefinitionKeys)
Only select historic case instances that don't have a case definition of which the key is present in the given list
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.caseDefinitionName(String caseDefinitionName)
Only select historic case instances that are defined by a case definition with the given name.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.caseDefinitionNameLike(String nameLike)
Only select historic case instances that are defined by case definition which name
is like the given value.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.caseInstanceBusinessKey(String caseInstanceBusinessKey)
Only select historic case instances with the given business key
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.caseInstanceBusinessKeyLike(String caseInstanceBusinessKeyLike)
Only select historic case instances which had a business key like the given value.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.caseInstanceId(String caseInstanceId)
Only select historic case instances with the given case instance id.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.caseInstanceIds(Set<String> caseInstanceIds)
Only select historic case instances whose id is in the given set of ids.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.closed()
Only select historic case instances which are closed
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.closedAfter(Date date)
Only select historic case instances that were closed after the given date.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.closedBefore(Date date)
Only select historic case instances that were closed before the given date.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.completed()
Only select historic case instances which are completed
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.createdAfter(Date date)
Only select historic case instances that were created after the given date.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.createdBefore(Date date)
Only select historic case instances that were created before the given date.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.createdBy(String userId)
Only select historic case instance that are created by the given user.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.matchVariableNamesIgnoreCase()
The query will match the names of variables in a case-insensitive way.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.matchVariableValuesIgnoreCase()
The query will match the values of variables in a case-insensitive way.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.notClosed()
Only select historic case instance that are not yet closed.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.orderByCaseDefinitionId()
Order by the case definition id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.orderByCaseInstanceBusinessKey()
Order by the business key (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.orderByCaseInstanceCloseTime()
Order by the close time (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.orderByCaseInstanceCreateTime()
Order by the create time (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.orderByCaseInstanceDuration()
Order by the duration of the case instance (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.orderByCaseInstanceId()
Order by the case instance id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.orderByTenantId()
Order by tenant id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.subCaseInstanceId(String subCaseInstanceId)
Only select historic case instances having a sub case instance
with the given case instance id.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.subProcessInstanceId(String subProcessInstanceId)
Only select historic case instances having a sub process instance
with the given process instance id.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.superCaseInstanceId(String superCaseInstanceId)
Only select historic case instances started by the given case instance.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.superProcessInstanceId(String superProcessInstanceId)
Only select historic case instances started by the given process instance.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.tenantIdIn(String... tenantIds)
Only select historic case instances with one of the given tenant ids.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.terminated()
Only select historic case instances which are terminated
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.variableValueEquals(String name,
Object value)
Only select case instances which have a global variable with the given value.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.variableValueGreaterThan(String name,
Object value)
Only select case instances which had a global variable with the given name
and a value greater than the given value when they where closed.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.variableValueGreaterThanOrEqual(String name,
Object value)
Only select case instances which have a global variable with the given name
and a value greater or equal than the given value.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.variableValueLessThan(String name,
Object value)
Only select case instances which have a global variable with the given name
and a value less than the given value.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.variableValueLessThanOrEqual(String name,
Object value)
Only select case instances which have a global variable with the given name
and a value less or equal than the given value.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.variableValueLike(String name,
String value)
Only select case instances which have a global variable with the given name
and a value like given value.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.variableValueNotEquals(String name,
Object value)
Only select case instances which have a global variable with the given name
but a different value.
|
HistoricCaseInstanceQuery |
HistoricCaseInstanceQuery.withoutTenantId()
Only selects historic case instances which have no tenant id.
|
Modifier and Type | Class and Description |
---|---|
class |
HistoricCaseInstanceQueryImpl |
Modifier and Type | Method and Description |
---|---|
protected HistoricCaseInstanceQuery |
HistoricCaseInstanceQueryDto.createNewQuery(ProcessEngine engine) |
Modifier and Type | Method and Description |
---|---|
protected void |
HistoricCaseInstanceQueryDto.applyFilters(HistoricCaseInstanceQuery query) |
protected void |
HistoricCaseInstanceQueryDto.applySortBy(HistoricCaseInstanceQuery query,
String sortBy,
Map<String,Object> parameters,
ProcessEngine engine) |
Copyright © 2022. All rights reserved.