| 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.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.activiti.engine.task |
Classes related to the
TaskService. |
| 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 |
TaskQuery.active()
Only selects tasks which are active (ie.
|
TaskQuery |
TaskQuery.dueAfter(Date dueDate)
Only select tasks which have a due date after the given date.
|
TaskQuery |
TaskQuery.dueBefore(Date dueDate)
Only select tasks which have a due date before the given date.
|
TaskQuery |
TaskQuery.dueDate(Date dueDate)
Only select tasks with the given due date.
|
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.includeProcessVariables()
Include global task variables in the task query result
|
TaskQuery |
TaskQuery.includeTaskLocalVariables()
Include local task variables in the task query result
|
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.orderByProcessInstanceId()
Order by process instance id (needs to be followed by
Query.asc() or Query.desc()). |
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.orderByTaskPriority()
Order by priority (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.processDefinitionKeyLike(String processDefinitionKeyLike)
Only select tasks which are part of a process instance which has a
process definition key like the given value.
|
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 processDefinitionNameLike)
Only select tasks which are part of a process instance which has a
process definition name like the given value.
|
TaskQuery |
TaskQuery.processInstanceBusinessKey(String processInstanceBusinessKey)
Only select tasks foe the given business key
|
TaskQuery |
TaskQuery.processInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)
Only select tasks with a business key like the given value
The syntax is that of SQL: for example usage: processInstanceBusinessKeyLike("%activiti%").
|
TaskQuery |
TaskQuery.processInstanceId(String processInstanceId)
Only select tasks for the given process instance id.
|
TaskQuery |
TaskQuery.processVariableValueEquals(Object variableValue)
Only select tasks which are part of a process that has at least one variable
with the given value.
|
TaskQuery |
TaskQuery.processVariableValueEquals(String variableName,
Object variableValue)
Only select tasks which are part of a process that has a variable
with the given name set to the given value.
|
TaskQuery |
TaskQuery.processVariableValueEqualsIgnoreCase(String name,
String value)
Only select tasks which are part of a process that has a local string variable which
is not the given value, case insensitive.
|
TaskQuery |
TaskQuery.processVariableValueGreaterThan(String name,
Object value)
Only select tasks which have a global variable value greater than the
passed value when they ended.
|
TaskQuery |
TaskQuery.processVariableValueGreaterThanOrEqual(String name,
Object value)
Only select tasks which have a global variable value greater than or
equal to the passed value when they ended.
|
TaskQuery |
TaskQuery.processVariableValueLessThan(String name,
Object value)
Only select tasks which have a global variable value less than the
passed value when the ended.Booleans,
Byte-arrays and
Serializable objects (which are not primitive type
wrappers) are not supported. |
TaskQuery |
TaskQuery.processVariableValueLessThanOrEqual(String name,
Object value)
Only select tasks which have a global variable value less than or equal
to the passed value when they ended.
|
TaskQuery |
TaskQuery.processVariableValueLike(String name,
String value)
Only select tasks which have a global variable value like the given value
when they ended.
|
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.processVariableValueNotEqualsIgnoreCase(String name,
String value)
Only select tasks which are part of a process that has a string variable with
the given value, case insensitive.
|
TaskQuery |
TaskQuery.suspended()
Only selects tasks which are suspended, because its process instance was suspended.
|
TaskQuery |
TaskQuery.taskAssignee(String assignee)
Only select tasks which are assigned to the given user.
|
TaskQuery |
TaskQuery.taskAssigneeLike(String assigneeLike)
Only select tasks which were last assigned to an assignee like
the given value.
|
TaskQuery |
TaskQuery.taskCandidateGroup(String candidateGroup)
Only select tasks for which users in the given group are candidates.
|
TaskQuery |
TaskQuery.taskCandidateGroupIn(List<String> candidateGroups)
Only select tasks for which the 'candidateGroup' is one of the given groups.
|
TaskQuery |
TaskQuery.taskCandidateUser(String candidateUser)
Only select tasks for which the given user is a candidate.
|
TaskQuery |
TaskQuery.taskCreatedAfter(Date after)
Only select tasks that are created after the given date.
|
TaskQuery |
TaskQuery.taskCreatedBefore(Date before)
Only select tasks that are created before the given date.
|
TaskQuery |
TaskQuery.taskCreatedOn(Date createTime)
Only select tasks that are created on the given date.
|
TaskQuery |
TaskQuery.taskDefinitionKey(String key)
Only select tasks with the given taskDefinitionKey.
|
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, including tasks which have been
assigned to the given user (assignee) or owned by the given user (owner). |
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.taskOwnerLike(String ownerLike)
Only select tasks which were last assigned to an owner like
the given value.
|
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(Object variableValue)
Only select tasks which have at least one local task variable with the given value.
|
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.taskVariableValueEqualsIgnoreCase(String name,
String value)
Only select tasks which have a local string variable with the given value,
case insensitive.
|
TaskQuery |
TaskQuery.taskVariableValueGreaterThan(String name,
Object value)
Only select tasks which have a local variable value greater than the
passed value when they ended.
|
TaskQuery |
TaskQuery.taskVariableValueGreaterThanOrEqual(String name,
Object value)
Only select tasks which have a local variable value greater than or
equal to the passed value when they ended.
|
TaskQuery |
TaskQuery.taskVariableValueLessThan(String name,
Object value)
Only select tasks which have a local variable value less than the
passed value when the ended.Booleans,
Byte-arrays and
Serializable objects (which are not primitive type
wrappers) are not supported. |
TaskQuery |
TaskQuery.taskVariableValueLessThanOrEqual(String name,
Object value)
Only select tasks which have a local variable value less than or equal
to the passed value when they ended.
|
TaskQuery |
TaskQuery.taskVariableValueLike(String name,
String value)
Only select tasks which have a local variable value like the given value
when they ended.
|
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.taskVariableValueNotEqualsIgnoreCase(String name,
String value)
Only select tasks which have a local string variable with is not the given value,
case insensitive.
|
TaskQuery |
TaskQuery.withoutDueDate()
Only select tasks with no due date.
|
Copyright © 2013 Alfresco. All rights reserved.