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 |
---|---|
HistoricTaskInstanceQuery |
HistoryService.createHistoricTaskInstanceQuery()
Creates a new programmatic query to search for
HistoricTaskInstance s. |
Modifier and Type | Method and Description |
---|---|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.activityInstanceIdIn(String... activityInstanceIds)
Only select historic task instances which have one of the given activity instance ids.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.caseDefinitionId(String caseDefinitionId)
Only select historic task instances for the given case definition.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.caseDefinitionKey(String caseDefinitionKey)
Only select historic task instances which are part of a case instance
which has the given case definition key.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.caseDefinitionName(String caseDefinitionName)
Only select historic task instances which are part of a (historic) case instance
which has the given case definition name.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.caseExecutionId(String caseExecutionId)
Only select historic task instances for the given case execution id.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.caseInstanceId(String caseInstanceId)
Only select historic task instances for the given case instance.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.endOr()
endOr() terminates an OR query on which an arbitrary amount of filter criteria were applied.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.executionId(String executionId)
Only select historic task instances for the given execution.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.finished()
Only select historic task instances which are finished.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.finishedAfter(Date date)
Only select tasks where end time is after given date
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.finishedBefore(Date date)
Only select tasks where end time is before given date
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.matchVariableNamesIgnoreCase()
The query will match the names of task and process variables in a case-insensitive way.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.matchVariableValuesIgnoreCase()
The query will match the values of task and process variables in a case-insensitive way.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.or()
After calling or(), a chain of several filter criteria could follow.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByCaseDefinitionId()
Order by case definition id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByCaseExecutionId()
Order by case execution id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByCaseInstanceId()
Order by case instance id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByDeleteReason()
Order by task delete reason (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByExecutionId()
Order by execution id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByHistoricActivityInstanceId()
Order by the historic activity instance id this task was used in
(needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByHistoricActivityInstanceStartTime()
Order by start time (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByHistoricTaskInstanceDuration()
Order by duration (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByHistoricTaskInstanceEndTime()
Order by end time (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByProcessDefinitionId()
Order by process definition id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByProcessInstanceId()
Order by process instance id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByTaskAssignee()
Order by task assignee (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByTaskDefinitionKey()
Order by task definition key (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByTaskDescription()
Order by task description (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByTaskDueDate()
Order by task due date (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByTaskFollowUpDate()
Order by task follow-up date (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByTaskId()
Order by task id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByTaskName()
Order by task name (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByTaskOwner()
Order by task owner (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByTaskPriority()
Order by task priority key (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.orderByTenantId()
Order by tenant id (needs to be followed by
Query.asc() or Query.desc() ). |
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processDefinitionId(String processDefinitionId)
Only select historic task instances for the given process definition.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processDefinitionKey(String processDefinitionKey)
Only select historic task instances which are part of a (historic) process instance
which has the given process definition key.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processDefinitionName(String processDefinitionName)
Only select historic task instances which are part of a (historic) process instance
which has the given definition name.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processFinished()
Only select historic task instances which are part of a process
instance which is already finished.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processInstanceBusinessKey(String processInstanceBusinessKey)
Only select historic tasks for the given process instance business key
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processInstanceBusinessKeyIn(String... processInstanceBusinessKeys)
Only select historic tasks for any of the given the given process instance business keys.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processInstanceBusinessKeyLike(String processInstanceBusinessKey)
Only select historic tasks matching the given process instance business key.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processInstanceId(String processInstanceId)
Only select historic task instances for the given process instance.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processUnfinished()
Only select historic task instances which are part of a process
instance which is not finished yet.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processVariableValueEquals(String variableName,
Object variableValue)
Only select historic task instances which are part of a process instance which have a variable
with the given name set to the given value.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processVariableValueGreaterThan(String variableName,
Object variableValue)
Only select historic task instances which are part of a process that have a variable
with the given name and a value greater than the given one.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processVariableValueGreaterThanOrEquals(String variableName,
Object variableValue)
Only select historic task instances which are part of a process that have a variable
with the given name and a value greater than or equal to the given one.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processVariableValueLessThan(String variableName,
Object variableValue)
Only select historic task instances which are part of a process that have a variable
with the given name and a value less than the given one.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processVariableValueLessThanOrEquals(String variableName,
Object variableValue)
Only select historic task instances which are part of a process that have a variable
with the given name and a value less than or equal to the given one.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processVariableValueLike(String variableName,
Object variableValue)
Only select historic task instances which are part of a process that have a variable
with the given name and matching the given value.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.processVariableValueNotEquals(String variableName,
Object variableValue)
Only select historic task instances which have a variable with the given name, but
with a different value than the passed value.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.startedAfter(Date date)
Only select tasks where started after given date
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.startedBefore(Date date)
Only select tasks where started before given date
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskAssigned()
Only select historic task instances with an assignee.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskAssignee(String taskAssignee)
Only select historic task instances which were last taskAssigned to the given assignee.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskAssigneeLike(String taskAssigneeLike)
Only select historic task instances which were last taskAssigned to an assignee like
the given value.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskDefinitionKey(String taskDefinitionKey)
Only select historic task instances with the given task definition key.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskDefinitionKeyIn(String... taskDefinitionKeys)
Only select historic task instances with one of the given task definition keys.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskDeleteReason(String taskDeleteReason)
Only select historic task instances with the given task delete reason.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskDeleteReasonLike(String taskDeleteReasonLike)
Only select historic task instances with a task description like the given value.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskDescription(String taskDescription)
Only select historic task instances with the given task description.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskDescriptionLike(String taskDescriptionLike)
Only select historic task instances with a task description like the given value.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskDueAfter(Date dueDate)
Only select select historic task instances which have a due date after the given date.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskDueBefore(Date dueDate)
Only select select historic task instances which have a due date before the given date.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskDueDate(Date dueDate)
Only select select historic task instances with the given due date.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskFollowUpAfter(Date followUpDate)
Only select select historic task instances which have a follow-up date after the given date.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskFollowUpBefore(Date followUpDate)
Only select select historic task instances which have a follow-up date before the given date.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskFollowUpDate(Date followUpDate)
Only select select historic task instances with the given follow-up date.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskHadCandidateGroup(String candidateGroup)
Only select historic task instances which have mapping
with Historic identity links with the condition of group being a candidate
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskHadCandidateUser(String candidateUser)
Only select historic task instances which have mapping
with Historic identity links with the condition of user being a candidate
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskId(String taskId)
Only select historic task instances for the given task id.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskInvolvedGroup(String involvedGroup)
Only select historic task instances which have mapping
with Historic identity links based on group id
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskInvolvedUser(String involvedUser)
Only select historic task instances which have mapping
with Historic identity links based on user id
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskName(String taskName)
Only select historic task instances with the given task name.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskNameLike(String taskNameLike)
Only select historic task instances with a task name like the given value.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskOwner(String taskOwner)
Only select historic task instances which have the given owner.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskOwnerLike(String taskOwnerLike)
Only select historic task instances which have an owner like the one specified.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskParentTaskId(String parentTaskId)
Only select subtasks of the given parent task
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskPriority(Integer taskPriority)
Only select historic task instances with the given priority.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskUnassigned()
Only select historic task instances without an assignee.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.taskVariableValueEquals(String variableName,
Object variableValue)
Only select historic task instances which have a local task variable with the
given name set to the given value.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.tenantIdIn(String... tenantIds)
Only select historic task instances with one of the given tenant ids.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.unfinished()
Only select historic task instances which aren't finished yet.
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.withCandidateGroups()
Only select historic task instances which have a candidate group
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.withoutCandidateGroups()
Only select historic task instances which have no candidate group
|
HistoricTaskInstanceQuery |
HistoricTaskInstanceQuery.withoutTenantId()
Only selects historic task instances that have no tenant id.
|
Modifier and Type | Class and Description |
---|---|
class |
HistoricTaskInstanceQueryImpl |
Modifier and Type | Method and Description |
---|---|
protected HistoricTaskInstanceQuery |
HistoricTaskInstanceQueryDto.createNewQuery(ProcessEngine engine) |
Modifier and Type | Method and Description |
---|---|
protected void |
HistoricTaskInstanceQueryDto.applyFilters(HistoricTaskInstanceQuery query) |
protected void |
HistoricTaskInstanceQueryDto.applySortBy(HistoricTaskInstanceQuery query,
String sortBy,
Map<String,Object> parameters,
ProcessEngine engine) |
Copyright © 2022. All rights reserved.