Package | Description |
---|---|
org.camunda.bpm.engine |
Public API of the camunda BPM 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.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
org.camunda.bpm.engine.impl.json | |
org.camunda.bpm.engine.rest.dto.task | |
org.camunda.bpm.engine.rest.impl | |
org.camunda.bpm.engine.task |
Classes related to the
TaskService . |
org.camunda.bpm.qa.upgrade |
Modifier and Type | Method and Description |
---|---|
TaskQuery |
TaskService.createTaskQuery()
Returns a new
TaskQuery that can be used to dynamically query tasks. |
Modifier and Type | Class and Description |
---|---|
class |
TaskQueryImpl |
Modifier and Type | Method and Description |
---|---|
TaskQuery |
TaskQueryImpl.extend(TaskQuery extending) |
Modifier and Type | Method and Description |
---|---|
TaskQuery |
JsonTaskQueryConverter.toObject(JSONObject json) |
Modifier and Type | Method and Description |
---|---|
JSONObject |
JsonTaskQueryConverter.toJsonObject(TaskQuery taskQuery) |
Modifier and Type | Method and Description |
---|---|
protected TaskQuery |
TaskQueryDto.createNewQuery(ProcessEngine engine) |
Modifier and Type | Method and Description |
---|---|
protected void |
TaskQueryDto.applyFilters(TaskQuery query) |
protected void |
TaskQueryDto.applySortBy(TaskQuery query,
String sortBy,
Map<String,Object> parameters,
ProcessEngine engine) |
Modifier and Type | Method and Description |
---|---|
protected List<Task> |
TaskRestServiceImpl.executePaginatedQuery(TaskQuery query,
Integer firstResult,
Integer maxResults) |
protected List<Task> |
TaskRestServiceImpl.executeTaskQuery(Integer firstResult,
Integer maxResults,
TaskQuery query) |
Modifier and Type | Method and Description |
---|---|
TaskQuery |
TaskQuery.active()
Only select tasks which are active (ie.
|
TaskQuery |
TaskQuery.activityInstanceIdIn(String... activityInstanceIds)
Only select task which have one of the activity instance ids.
|
TaskQuery |
TaskQuery.caseDefinitionId(String caseDefinitionId)
Only select tasks which are part of a case instance which has the given
case definition id.
|
TaskQuery |
TaskQuery.caseDefinitionKey(String caseDefinitionKey)
Only select tasks which are part of a case instance which has the given
case definition key.
|
TaskQuery |
TaskQuery.caseDefinitionName(String caseDefinitionName)
Only select tasks which are part of a case instance which has the given
case definition name.
|
TaskQuery |
TaskQuery.caseDefinitionNameLike(String caseDefinitionNameLike)
Only select tasks which are part of a case instance which case definition
name is like the given parameter.
|
TaskQuery |
TaskQuery.caseExecutionId(String caseExecutionId)
Only select tasks for the given case execution.
|
TaskQuery |
TaskQuery.caseInstanceBusinessKey(String caseInstanceBusinessKey)
Only select tasks for the given case instance business key
|
TaskQuery |
TaskQuery.caseInstanceBusinessKeyLike(String caseInstanceBusinessKeyLike)
Only select tasks matching the given case instance business key.
|
TaskQuery |
TaskQuery.caseInstanceId(String caseInstanceId)
Only select tasks for the given case instance id.
|
TaskQuery |
TaskQuery.caseInstanceVariableValueEquals(String variableName,
Object variableValue)
Only select tasks which are part of a case instance that have a variable
with the given name set to the given value.
|
TaskQuery |
TaskQuery.caseInstanceVariableValueGreaterThan(String variableName,
Object variableValue)
Only select tasks which are part of a case instance that have a variable
with the given name and a variable value greater than the passed value.
|
TaskQuery |
TaskQuery.caseInstanceVariableValueGreaterThanOrEquals(String variableName,
Object variableValue)
Only select tasks which are part of a case instance that have a
variable value greater than or equal to the passed value.
|
TaskQuery |
TaskQuery.caseInstanceVariableValueLessThan(String variableName,
Object variableValue)
Only select tasks which are part of a case instance that have a variable
value less than the passed value.
|
TaskQuery |
TaskQuery.caseInstanceVariableValueLessThanOrEquals(String variableName,
Object variableValue)
Only select tasks which are part of a case instance that have a variable
value less than or equal to the passed value.
|
TaskQuery |
TaskQuery.caseInstanceVariableValueLike(String variableName,
String variableValue)
Only select tasks which are part of a case instance that have a variable value
like the given value.
|
TaskQuery |
TaskQuery.caseInstanceVariableValueNotEquals(String variableName,
Object variableValue)
Only select tasks which are part of a case instance that have a variable
with the given name, but with a different value than the passed value.
|
TaskQuery |
TaskQuery.dueAfter(Date dueDate)
Only select tasks which have a due date after the given date.
|
TaskQuery |
TaskQuery.dueAfterExpression(String dueDateExpression)
Only select tasks which have a due date after the described date by the given expression.
|
TaskQuery |
TaskQuery.dueBefore(Date dueDate)
Only select tasks which have a due date before the given date.
|
TaskQuery |
TaskQuery.dueBeforeExpression(String dueDateExpression)
Only select tasks which have a due date before the described date by the given expression.
|
TaskQuery |
TaskQuery.dueDate(Date dueDate)
Only select tasks with the given due date.
|
TaskQuery |
TaskQuery.dueDateExpression(String dueDateExpression)
Only select tasks with the described due date by the given expression.
|
TaskQuery |
TaskQuery.excludeSubtasks()
Only select tasks that have no parent (i.e.
|
TaskQuery |
TaskQuery.executionId(String executionId)
Only select tasks for the given execution.
|
TaskQuery |
TaskQuery.followUpAfter(Date followUpDate)
Only select tasks which have a follow-up date after the given date.
|
TaskQuery |
TaskQuery.followUpAfterExpression(String followUpDateExpression)
Only select tasks which have a follow-up date after the described date by the given expression.
|
TaskQuery |
TaskQuery.followUpBefore(Date followUpDate)
Only select tasks which have a follow-up date before the given date.
|
TaskQuery |
TaskQuery.followUpBeforeExpression(String followUpDateExpression)
Only select tasks which have a follow-up date before the described date by the given expression.
|
TaskQuery |
TaskQuery.followUpBeforeOrNotExistent(Date followUpDate)
Only select tasks which have no follow-up date or a follow-up date before the given date.
|
TaskQuery |
TaskQuery.followUpBeforeOrNotExistentExpression(String followUpDateExpression)
Only select tasks which have no follow-up date or a follow-up date before the described date by the given expression.
|
TaskQuery |
TaskQuery.followUpDate(Date followUpDate)
Only select tasks with the given follow-up date.
|
TaskQuery |
TaskQuery.followUpDateExpression(String followUpDateExpression)
Only select tasks with the described follow-up date by the given expression.
|
TaskQuery |
TaskQuery.includeAssignedTasks()
Select both assigned and not assigned tasks for candidate user or group queries.
|
TaskQuery |
TaskQuery.initializeFormKeys()
If called, the form keys of the fetched tasks are initialized and
Task.getFormKey() will return a value (in case the task has a form key). |
TaskQuery |
TaskQuery.orderByCaseExecutionId()
Order by case execution id (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByCaseExecutionVariable(String variableName,
org.camunda.bpm.engine.variable.type.ValueType valueType)
Order by a task variable value of a certain type.
|
TaskQuery |
TaskQuery.orderByCaseInstanceId()
Order by case instance id (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByCaseInstanceVariable(String variableName,
org.camunda.bpm.engine.variable.type.ValueType valueType)
Order by a task variable value of a certain type.
|
TaskQuery |
TaskQuery.orderByDueDate()
Order by due date (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByExecutionId()
Order by execution id (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByExecutionVariable(String variableName,
org.camunda.bpm.engine.variable.type.ValueType valueType)
Order by an execution variable value of a certain type.
|
TaskQuery |
TaskQuery.orderByFollowUpDate()
Order by follow-up date (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByProcessInstanceId()
Order by process instance id (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByProcessVariable(String variableName,
org.camunda.bpm.engine.variable.type.ValueType valueType)
Order by a process instance variable value of a certain type.
|
TaskQuery |
TaskQuery.orderByTaskAssignee()
Order by assignee (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByTaskCreateTime()
Order by the time on which the tasks were created (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByTaskDescription()
Order by description (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByTaskId()
Order by task id (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByTaskName()
Order by task name (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByTaskNameCaseInsensitive()
Order by task name case insensitive (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByTaskPriority()
Order by priority (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.orderByTaskVariable(String variableName,
org.camunda.bpm.engine.variable.type.ValueType valueType)
Order by a task variable value of a certain type.
|
TaskQuery |
TaskQuery.orderByTenantId()
Order by tenant id (needs to be followed by
Query.asc() or Query.desc() ). |
TaskQuery |
TaskQuery.processDefinitionId(String processDefinitionId)
Only select tasks which are part of a process instance which has the given
process definition id.
|
TaskQuery |
TaskQuery.processDefinitionKey(String processDefinitionKey)
Only select tasks which are part of a process instance which has the given
process definition key.
|
TaskQuery |
TaskQuery.processDefinitionKeyIn(String... processDefinitionKeys)
Only select tasks which are part of a process instance which has one of the
given process definition keys.
|
TaskQuery |
TaskQuery.processDefinitionName(String processDefinitionName)
Only select tasks which are part of a process instance which has the given
process definition name.
|
TaskQuery |
TaskQuery.processDefinitionNameLike(String processDefinitionName)
Only select tasks which are part of a process instance which process definition
name is like the given parameter.
|
TaskQuery |
TaskQuery.processInstanceBusinessKey(String processInstanceBusinessKey)
Only select tasks for the given process instance business key
|
TaskQuery |
TaskQuery.processInstanceBusinessKeyIn(String... processInstanceBusinessKeys)
Only select tasks for any of the given the given process instance business keys.
|
TaskQuery |
TaskQuery.processInstanceBusinessKeyLike(String processInstanceBusinessKey)
Only select tasks matching the given process instance business key.
|
TaskQuery |
TaskQuery.processInstanceId(String processInstanceId)
Only select tasks for the given process instance id.
|
TaskQuery |
TaskQuery.processVariableValueEquals(String variableName,
Object variableValue)
Only select tasks which have are part of a process that have a variable
with the given name set to the given value.
|
TaskQuery |
TaskQuery.processVariableValueGreaterThan(String variableName,
Object variableValue)
Only select tasks which are part of a process that have a variable
with the given name and a value greater than the given one.
|
TaskQuery |
TaskQuery.processVariableValueGreaterThanOrEquals(String variableName,
Object variableValue)
Only select tasks 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.
|
TaskQuery |
TaskQuery.processVariableValueLessThan(String variableName,
Object variableValue)
Only select tasks which are part of a process that have a variable
with the given name and a value less than the given one.
|
TaskQuery |
TaskQuery.processVariableValueLessThanOrEquals(String variableName,
Object variableValue)
Only select tasks 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.
|
TaskQuery |
TaskQuery.processVariableValueLike(String variableName,
String variableValue)
Only select tasks which are part of a process that have a variable
with the given name and matching the given value.
|
TaskQuery |
TaskQuery.processVariableValueNotEquals(String variableName,
Object variableValue)
Only select tasks which have a variable with the given name, but
with a different value than the passed value.
|
TaskQuery |
TaskQuery.suspended()
Only select tasks which are suspended, because its process instance was suspended.
|
TaskQuery |
TaskQuery.taskAssigned()
Only select tasks which have an assignee.
|
TaskQuery |
TaskQuery.taskAssignee(String assignee)
Only select tasks which are assigned to the given user.
|
TaskQuery |
TaskQuery.taskAssigneeExpression(String assigneeExpression)
Only select tasks which are assigned to the user described by the given expression.
|
TaskQuery |
TaskQuery.taskAssigneeLike(String assignee)
Only select tasks which are matching the given user.
|
TaskQuery |
TaskQuery.taskAssigneeLikeExpression(String assigneeLikeExpression)
Only select tasks which are assigned to the user described by the given expression.
|
TaskQuery |
TaskQuery.taskCandidateGroup(String candidateGroup)
Only select tasks for which users in the given group are candidates.
|
TaskQuery |
TaskQuery.taskCandidateGroupExpression(String candidateGroupExpression)
Only select tasks for which users in the described group by the given expression are candidates.
|
TaskQuery |
TaskQuery.taskCandidateGroupIn(List<String> candidateGroups)
Only select tasks for which the 'candidateGroup' is one of the given groups.
|
TaskQuery |
TaskQuery.taskCandidateGroupInExpression(String candidateGroupsExpression)
Only select tasks for which the 'candidateGroup' is one of the described groups of the given expression.
|
TaskQuery |
TaskQuery.taskCandidateUser(String candidateUser)
Only select tasks for which the given user or one of his groups is a candidate.
|
TaskQuery |
TaskQuery.taskCandidateUserExpression(String candidateUserExpression)
Only select tasks for which the described user by the given expression is a candidate.
|
TaskQuery |
TaskQuery.taskCreatedAfter(Date after)
Only select tasks that are created after the given date.
|
TaskQuery |
TaskQuery.taskCreatedAfterExpression(String afterExpression)
Only select tasks that are created after the described date by the given expression.
|
TaskQuery |
TaskQuery.taskCreatedBefore(Date before)
Only select tasks that are created before the given date.
|
TaskQuery |
TaskQuery.taskCreatedBeforeExpression(String beforeExpression)
Only select tasks that are created before the described date by the given expression.
|
TaskQuery |
TaskQuery.taskCreatedOn(Date createTime)
Only select tasks that are created on the given date.
|
TaskQuery |
TaskQuery.taskCreatedOnExpression(String createTimeExpression)
Only select tasks that are created on the described date by the given expression.
|
TaskQuery |
TaskQuery.taskDefinitionKey(String key)
Only select tasks with the given taskDefinitionKey.
|
TaskQuery |
TaskQuery.taskDefinitionKeyIn(String... taskDefinitionKeys)
Only select tasks which have one of the taskDefinitionKeys.
|
TaskQuery |
TaskQuery.taskDefinitionKeyLike(String keyLike)
Only select tasks with a taskDefinitionKey that match the given parameter.
|
TaskQuery |
TaskQuery.taskDelegationState(DelegationState delegationState)
Only select tasks with the given
DelegationState . |
TaskQuery |
TaskQuery.taskDescription(String description)
Only select tasks with the given description.
|
TaskQuery |
TaskQuery.taskDescriptionLike(String descriptionLike)
Only select tasks with a description matching the parameter .
|
TaskQuery |
TaskQuery.taskId(String taskId)
Only select tasks with the given task id (in practice, there will be
maximum one of this kind)
|
TaskQuery |
TaskQuery.taskInvolvedUser(String involvedUser)
Only select tasks for which there exist an
IdentityLink with the given user |
TaskQuery |
TaskQuery.taskInvolvedUserExpression(String involvedUserExpression)
Only select tasks for which there exist an
IdentityLink with the
described user by the given expression |
TaskQuery |
TaskQuery.taskMaxPriority(Integer maxPriority)
Only select tasks with the given priority or lower.
|
TaskQuery |
TaskQuery.taskMinPriority(Integer minPriority)
Only select tasks with the given priority or higher.
|
TaskQuery |
TaskQuery.taskName(String name)
Only select tasks with the given name
|
TaskQuery |
TaskQuery.taskNameLike(String nameLike)
Only select tasks with a name matching the parameter.
|
TaskQuery |
TaskQuery.taskOwner(String owner)
Only select tasks for which the given user is the owner.
|
TaskQuery |
TaskQuery.taskOwnerExpression(String ownerExpression)
Only select tasks for which the described user by the given expression is the owner.
|
TaskQuery |
TaskQuery.taskParentTaskId(String parentTaskId)
Select the tasks which are sub tasks of the given parent task.
|
TaskQuery |
TaskQuery.taskPriority(Integer priority)
Only select tasks with the given priority.
|
TaskQuery |
TaskQuery.taskUnassigned()
Only select tasks which don't have an assignee.
|
TaskQuery |
TaskQuery.taskUnnassigned()
Deprecated.
|
TaskQuery |
TaskQuery.taskVariableValueEquals(String variableName,
Object variableValue)
Only select tasks which have a local task variable with the given name
set to the given value.
|
TaskQuery |
TaskQuery.taskVariableValueGreaterThan(String variableName,
Object variableValue)
Only select tasks which have a local task variable with the given name
and a value greater than the given one.
|
TaskQuery |
TaskQuery.taskVariableValueGreaterThanOrEquals(String variableName,
Object variableValue)
Only select tasks which have a local task variable with the given name
and a value greater than or equal to the given one.
|
TaskQuery |
TaskQuery.taskVariableValueLessThan(String variableName,
Object variableValue)
Only select tasks which have a local task variable with the given name
and a value less than the given one.
|
TaskQuery |
TaskQuery.taskVariableValueLessThanOrEquals(String variableName,
Object variableValue)
Only select tasks which have a local task variable with the given name
and a value less than or equal to the given one.
|
TaskQuery |
TaskQuery.taskVariableValueLike(String variableName,
String variableValue)
Only select tasks which have a local task variable with the given name
matching the given value.
|
TaskQuery |
TaskQuery.taskVariableValueNotEquals(String variableName,
Object variableValue)
Only select tasks which have a local task variable with the given name, but
with a different value than the passed value.
|
TaskQuery |
TaskQuery.tenantIdIn(String... tenantIds)
Only select tasks with one of the given tenant ids.
|
TaskQuery |
TaskQuery.withCandidateGroups()
Only select tasks which have a candidate group
|
TaskQuery |
TaskQuery.withoutCandidateGroups()
Only select tasks which have no candidate group
|
TaskQuery |
TaskQuery.withoutTenantId()
Only select tasks which have no tenant id.
|
Modifier and Type | Method and Description |
---|---|
TaskQuery |
UpgradeTestRule.taskQuery() |
Copyright © 2018. All rights reserved.