Interface TaskInfoQuery<T extends TaskInfoQuery<?,?>,V extends TaskInfo>
- All Superinterfaces:
org.flowable.common.engine.api.query.Query<T,
V>
- All Known Subinterfaces:
HistoricTaskInstanceQuery
,TaskQuery
TaskQuery
and the HistoricTaskInstanceQuery
.- Author:
- Joram Barrez
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
org.flowable.common.engine.api.query.Query.NullHandlingOnOrder
-
Method Summary
Modifier and TypeMethodDescriptioncaseDefinitionId
(String caseDefinitionId) Only select tasks for the given case definition.caseDefinitionKey
(String caseDefinitionKey) Only select tasks which are part of a case instance which has the given case definition key.caseDefinitionKeyIn
(Collection<String> caseDefinitionKeys) Only select tasks that have a case definition for which the key is present in the given listcaseDefinitionKeyLike
(String caseDefinitionKeyLike) Only select tasks which are part of a case instance which has a case definition key like the given value.caseDefinitionKeyLikeIgnoreCase
(String caseDefinitionKeyLikeIgnoreCase) Only select tasks which are part of a case instance which has a case definition key like the given value.caseInstanceId
(String caseInstanceId) Only select tasks for the given case instance.caseInstanceIdWithChildren
(String caseInstanceId) Select all tasks for the given case instance id and its children.caseVariableExists
(String name) Only select tasks which have a global variable with the given name.caseVariableNotExists
(String name) Only select tasks which does not have a global variable with the given name.caseVariableValueEquals
(Object variableValue) Only select tasks which are part of a case that has at least one variable with the given value.caseVariableValueEquals
(String variableName, Object variableValue) Only select tasks which are part of a case that has a variable with the given name set to the given value.caseVariableValueEqualsIgnoreCase
(String name, String value) Only select tasks which are part of a case that has a local string variable which is not the given value, case insensitive.caseVariableValueGreaterThan
(String name, Object value) Only select tasks which have a global variable value greater than the passed value when they ended.caseVariableValueGreaterThanOrEqual
(String name, Object value) Only select tasks which have a global variable value greater than or equal to the passed value when they ended.caseVariableValueLessThan
(String name, Object value) Only select tasks which have a global variable value less than the passed value when the ended.Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.caseVariableValueLessThanOrEqual
(String name, Object value) Only select tasks which have a global variable value less than or equal to the passed value when they ended.caseVariableValueLike
(String name, String value) Only select tasks which have a global variable value like the given value when they ended.caseVariableValueLikeIgnoreCase
(String name, String value) Only select tasks which have a global variable value like the given value (case insensitive) when they ended.caseVariableValueNotEquals
(String variableName, Object variableValue) Only select tasks which have a variable with the given name, but with a different value than the passed value.caseVariableValueNotEqualsIgnoreCase
(String name, String value) Only select tasks which are part of a case that has a string variable with the given value, case insensitive.cmmnDeploymentId
(String cmmnDeploymentId) Only select tasks which are related to a case instance for to the given deployment id.cmmnDeploymentIdIn
(Collection<String> cmmnDeploymentIds) Only select tasks which are related to a case instances for the given deployment id.deploymentId
(String deploymentId) Only select tasks which are part of a process instance which has the given deployment id.deploymentIdIn
(Collection<String> deploymentIds) Only select tasks which are part of a process instance which has the given deployment id.endOr()
executionId
(String executionId) Only select tasks for the given execution.Allows to select a task usingtaskCandidateGroup(String)
taskCandidateGroupIn(Collection)
ortaskCandidateUser(String)
but ignore the assignee value instead of querying for an empty assignee.Include global case variables in the task query resultInclude identity links in the task query resultInclude global process variables in the task query resultInclude local task variables in the task query resultLocalize task name and description to specified locale.or()
All query clauses called will be added to a single or-statement.Order by category (needs to be followed byQuery.asc()
orQuery.desc()
).Order by due date (needs to be followed byQuery.asc()
orQuery.desc()
).Order by due date (needs to be followed byQuery.asc()
orQuery.desc()
).Order by execution id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by process instance id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by assignee (needs to be followed byQuery.asc()
orQuery.desc()
).Order by the time on which the tasks were created (needs to be followed byQuery.asc()
orQuery.desc()
).Order by task definition key (needs to be followed byQuery.asc()
orQuery.desc()
).Order by description (needs to be followed byQuery.asc()
orQuery.desc()
).Order by task due date (needs to be followed byQuery.asc()
orQuery.desc()
).Order by task id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by task name (needs to be followed byQuery.asc()
orQuery.desc()
).Order by task owner (needs to be followed byQuery.asc()
orQuery.desc()
).Order by priority (needs to be followed byQuery.asc()
orQuery.desc()
).Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).planItemInstanceId
(String planItemInstanceId) Only select tasks for the given plan item instance.processCategoryIn
(Collection<String> processCategoryInList) Only select tasks which are part of a process instance whose definition belongs to the category which is present in the given list.processCategoryNotIn
(Collection<String> processCategoryNotInList) Only select tasks which are part of a process instance whose definition does not belong to the category which is present in the given list.processDefinitionId
(String processDefinitionId) Only select tasks which are part of a process instance which has the given process definition id.processDefinitionKey
(String processDefinitionKey) Only select tasks which are part of a process instance which has the given process definition key.processDefinitionKeyIn
(Collection<String> processDefinitionKeys) Only select tasks that have a process definition for which the key is present in the given listprocessDefinitionKeyLike
(String processDefinitionKeyLike) Only select tasks which are part of a process instance which has a process definition key like the given value.processDefinitionKeyLikeIgnoreCase
(String processDefinitionKeyLikeIgnoreCase) Only select tasks which are part of a process instance which has a process definition key like the given value.processDefinitionName
(String processDefinitionName) Only select tasks which are part of a process instance which has the given process definition name.processDefinitionNameLike
(String processDefinitionNameLike) Only select tasks which are part of a process instance which has a process definition name like the given value.processInstanceBusinessKey
(String processInstanceBusinessKey) Only select tasks for the given business keyprocessInstanceBusinessKeyLike
(String processInstanceBusinessKeyLike) Only select tasks with a business key like the given value The syntax is that of SQL: for example usage: processInstanceBusinessKeyLike("%test%").processInstanceBusinessKeyLikeIgnoreCase
(String processInstanceBusinessKeyLikeIgnoreCase) Only select tasks with a business key like the given value The syntax is that of SQL: for example usage: processInstanceBusinessKeyLike("%test%").processInstanceId
(String processInstanceId) Only select tasks for the given process instance id.processInstanceIdIn
(Collection<String> processInstanceIds) Only select tasks for the given process ids.processInstanceIdWithChildren
(String processInstanceId) Select all tasks for the given process instance id and its children.processVariableExists
(String name) Only select tasks which have a global variable with the given name.Only select tasks which does not have a global variable with the given name.processVariableValueEquals
(Object variableValue) Only select tasks which are part of a process that has at least one variable with the given value.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.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.processVariableValueGreaterThan
(String name, Object value) Only select tasks which have a global variable value greater than the passed value when they ended.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.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 andSerializable
objects (which are not primitive type wrappers) are not supported.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.processVariableValueLike
(String name, String value) Only select tasks which have a global variable value like the given value when they ended.processVariableValueLikeIgnoreCase
(String name, String value) Only select tasks which have a global variable value like the given value (case insensitive) when they ended.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.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.propagatedStageInstanceId
(String propagatedStageInstanceId) Only select tasks for the given stage, defined through its stage instance id.scopeDefinitionId
(String scopeDefinitionId) Only select tasks for the given scope definition identifier.Only select tasks for the given scope identifier.Only select tasks for the given scope type.subScopeId
(String subScopeId) Only select tasks for the given sub scope identifier.Only select tasks which are assigned to any usertaskAssignee
(String assignee) Only select tasks which are assigned to the given user.taskAssigneeIds
(Collection<String> assigneeListIds) Only select tasks with an assignee that is in the given listtaskAssigneeLike
(String assigneeLike) Only select tasks which were last assigned to an assignee like the given value.taskAssigneeLikeIgnoreCase
(String assigneeLikeIgnoreCase) Only select tasks which were last assigned to an assignee like the given value.taskCandidateGroup
(String candidateGroup) Only select tasks for which users in the given group are candidates.taskCandidateGroupIn
(Collection<String> candidateGroups) Only select tasks for which the 'candidateGroup' is one of the given groups.taskCandidateUser
(String candidateUser) Only select tasks for which the given user is a candidate.taskCategory
(String category) Only select tasks with the given category.taskCategoryIn
(Collection<String> taskCategoryInList) Only select tasks belonging to one of the categories in the given list.taskCategoryNotIn
(Collection<String> taskCategoryNotInList) Only select tasks with a defined category which do not belong to a category present in the given list.taskClaimedAfter
(Date after) Only select tasks that are claimed after the given date.taskClaimedBefore
(Date before) Only select tasks that are claimed before the given date.taskClaimedBy
(String claimedBy) Select all tasks that have a claimed by user reference for the given value.taskClaimedOn
(Date claimedTime) Only select tasks that are claimed on the given date.taskCreatedAfter
(Date after) Only select tasks that are created after the given date.taskCreatedBefore
(Date before) Only select tasks that are created before the given date.taskCreatedOn
(Date createTime) Only select tasks that are created on the given date.taskDefinitionId
(String taskDefinitionId) Only select tasks which created from the given task definition referenced by id.taskDefinitionKey
(String key) Only select tasks with the given taskDefinitionKey.taskDefinitionKeyLike
(String keyLike) Only select tasks with a taskDefinitionKey that match the given parameter.taskDefinitionKeys
(Collection<String> keys) Only select tasks with the given taskDefinitionKeys.taskDescription
(String description) Only select tasks with the given description.taskDescriptionLike
(String descriptionLike) Only select tasks with a description matching the parameter .taskDescriptionLikeIgnoreCase
(String descriptionLike) Only select tasks with a description matching the parameter .taskDueAfter
(Date dueDate) Only select tasks which have a due date after the given date.taskDueBefore
(Date dueDate) Only select tasks which have a due date before the given date.taskDueDate
(Date dueDate) Only select tasks with the given due date.taskFormKey
(String formKey) Only select tasks with the given formKey.Only select tasks with the given task id (in practice, there will be maximum one of this kind)taskIds
(Collection<String> taskIds) Only select tasks with an id that is in the given listtaskInProgressStartDueAfter
(Date dueDate) Only select tasks which have an in progress start due date after the given date.taskInProgressStartDueBefore
(Date dueDate) Only select tasks which have an in progress start due date before the given date.taskInProgressStartDueDate
(Date dueDate) Only select tasks with the given in progress start due date.taskInProgressStartedBy
(String startedBy) Select all tasks that have an in progress started user reference for the given value.taskInProgressStartTimeAfter
(Date after) Only select tasks that are started in progress after the given date.taskInProgressStartTimeBefore
(Date before) Only select tasks that are started in progress before the given date.taskInProgressStartTimeOn
(Date claimedTime) Only select tasks that are started in progress on the given date.taskInvolvedGroups
(Collection<String> involvedGroup) Only select tasks for which there exist anIdentityLink
with the given Groups.taskInvolvedUser
(String involvedUser) Only select tasks for which there exist anIdentityLink
with the given user, including tasks which have been assigned to the given user (assignee) or owned by the given user (owner).taskMaxPriority
(Integer maxPriority) Only select tasks with the given priority or lower.taskMinPriority
(Integer minPriority) Only select tasks with the given priority or higher.Only select tasks with the given nametaskNameIn
(Collection<String> nameList) Only select tasks with a name that is in the given listtaskNameInIgnoreCase
(Collection<String> nameList) Only select tasks with a name that is in the given list This method, unlike thetaskNameIn(Collection)
method will not take in account the upper/lower case: both the input parameters as the column value are lowercased when the query is executed.taskNameLike
(String nameLike) Only select tasks with a name matching the parameter.taskNameLikeIgnoreCase
(String nameLike) Only select tasks with a name matching the parameter.Only select tasks for which the given user is the owner.taskOwnerLike
(String ownerLike) Only select tasks which were last assigned to an owner like the given value.taskOwnerLikeIgnoreCase
(String ownerLikeIgnoreCase) Only select tasks which were last assigned to an owner like the given value.taskParentScopeId
(String parentScopeId) Only selects tasks which with the given parent scope idtaskPriority
(Integer priority) Only select tasks with the given priority.taskRootScopeId
(String parentScopeId) Only selects tasks which with the given root scope idOnly select tasks with the given state.taskSuspendedAfter
(Date after) Only select tasks that are suspended after the given date.taskSuspendedBefore
(Date before) Only select tasks that are suspended before the given date.taskSuspendedBy
(String suspendedBy) Select all tasks that have a suspended by user reference for the given value.taskSuspendedOn
(Date suspendedTime) Only select tasks that are suspended on the given date.taskTenantId
(String tenantId) Only select tasks that have the given tenant id.taskTenantIdLike
(String tenantIdLike) Only select tasks with a tenant id like the given one.Only select tasks which don't have an assignee.taskVariableExists
(String name) Only select tasks which have a local variable with the given name.taskVariableNotExists
(String name) Only select tasks which does not have a local variable with the given name.taskVariableValueEquals
(Object variableValue) Only select tasks which have at least one local task variable with the given value.taskVariableValueEquals
(String variableName, Object variableValue) Only select tasks which have a local task variable with the given name set to the given value.taskVariableValueEqualsIgnoreCase
(String name, String value) Only select tasks which have a local string variable with the given value, case insensitive.taskVariableValueGreaterThan
(String name, Object value) Only select tasks which have a local variable value greater than the passed value when they ended.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.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 andSerializable
objects (which are not primitive type wrappers) are not supported.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.taskVariableValueLike
(String name, String value) Only select tasks which have a local variable value like the given value when they ended.taskVariableValueLikeIgnoreCase
(String name, String value) Only select tasks which have a local variable value like the given value (case insensitive) when they ended.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.taskVariableValueNotEqualsIgnoreCase
(String name, String value) Only select tasks which have a local string variable with is not the given value, case insensitive.Only select tasks with form key.Selects tasks without category.Only select tasks that do not have a tenant id.Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.Only select tasks without a process instance id.Only select tasks which don't have a scope id set.Only select tasks with no due date.Only select tasks with no in progress start due date.Methods inherited from interface org.flowable.common.engine.api.query.Query
asc, count, desc, list, listPage, orderBy, orderBy, singleResult
-
Method Details
-
taskId
Only select tasks with the given task id (in practice, there will be maximum one of this kind) -
taskIds
Only select tasks with an id that is in the given list- Throws:
org.flowable.common.engine.api.FlowableIllegalArgumentException
- When passed id list is empty ornull
or containsnull String
.
-
taskName
Only select tasks with the given name -
taskNameIn
Only select tasks with a name that is in the given list- Throws:
org.flowable.common.engine.api.FlowableIllegalArgumentException
- When passed name list is empty ornull
or containsnull String
.
-
taskNameInIgnoreCase
Only select tasks with a name that is in the given list This method, unlike thetaskNameIn(Collection)
method will not take in account the upper/lower case: both the input parameters as the column value are lowercased when the query is executed.- Throws:
org.flowable.common.engine.api.FlowableIllegalArgumentException
- When passed name list is empty ornull
or containsnull String
.
-
taskNameLike
Only select tasks with a name matching the parameter. The syntax is that of SQL: for example usage: nameLike(%test%) -
taskNameLikeIgnoreCase
Only select tasks with a name matching the parameter. The syntax is that of SQL: for example usage: nameLike(%test%) This method, unlike thetaskNameLike(String)
method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the query is executed. -
taskDescription
Only select tasks with the given description. -
taskDescriptionLike
Only select tasks with a description matching the parameter . The syntax is that of SQL: for example usage: descriptionLike(%test%) -
taskDescriptionLikeIgnoreCase
Only select tasks with a description matching the parameter . The syntax is that of SQL: for example usage: descriptionLike(%test%) This method, unlike thetaskDescriptionLike(String)
method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the query is executed. -
taskPriority
Only select tasks with the given priority. -
taskMinPriority
Only select tasks with the given priority or higher. -
taskMaxPriority
Only select tasks with the given priority or lower. -
taskAssignee
Only select tasks which are assigned to the given user. -
taskAssigneeLike
Only select tasks which were last assigned to an assignee like the given value. The syntax that should be used is the same as in SQL, eg. %test%. -
taskAssigneeLikeIgnoreCase
Only select tasks which were last assigned to an assignee like the given value. The syntax that should be used is the same as in SQL, eg. %test%. This method, unlike thetaskAssigneeLike(String)
method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the query is executed. -
taskUnassigned
T taskUnassigned()Only select tasks which don't have an assignee. -
taskAssigned
T taskAssigned()Only select tasks which are assigned to any user -
taskAssigneeIds
Only select tasks with an assignee that is in the given list- Throws:
org.flowable.common.engine.api.FlowableIllegalArgumentException
- When passed name list is empty ornull
or containsnull String
.
-
taskOwner
Only select tasks for which the given user is the owner. -
taskOwnerLike
Only select tasks which were last assigned to an owner like the given value. The syntax that should be used is the same as in SQL, eg. %test%. -
taskOwnerLikeIgnoreCase
Only select tasks which were last assigned to an owner like the given value. The syntax that should be used is the same as in SQL, eg. %test%. This method, unlike thetaskOwnerLike(String)
method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the query is executed. -
taskCandidateUser
Only select tasks for which the given user is a candidate. -
taskInvolvedUser
Only select tasks for which there exist anIdentityLink
with the given user, including tasks which have been assigned to the given user (assignee) or owned by the given user (owner). -
taskInvolvedGroups
Only select tasks for which there exist anIdentityLink
with the given Groups. -
ignoreAssigneeValue
T ignoreAssigneeValue()Allows to select a task usingtaskCandidateGroup(String)
taskCandidateGroupIn(Collection)
ortaskCandidateUser(String)
but ignore the assignee value instead of querying for an empty assignee. -
taskCandidateGroup
Only select tasks for which users in the given group are candidates. -
taskCandidateGroupIn
Only select tasks for which the 'candidateGroup' is one of the given groups.- Throws:
org.flowable.common.engine.api.FlowableIllegalArgumentException
- When query is executed andtaskCandidateGroup(String)
ortaskCandidateUser(String)
has been executed on the query instance. When passed group list is empty ornull
.
-
taskTenantId
Only select tasks that have the given tenant id. -
taskTenantIdLike
Only select tasks with a tenant id like the given one. -
taskWithoutTenantId
T taskWithoutTenantId()Only select tasks that do not have a tenant id. -
processInstanceId
Only select tasks for the given process instance id. -
processInstanceIdIn
Only select tasks for the given process ids. -
withoutProcessInstanceId
T withoutProcessInstanceId()Only select tasks without a process instance id. -
processInstanceBusinessKey
Only select tasks for the given business key -
processInstanceBusinessKeyLike
Only select tasks with a business key like the given value The syntax is that of SQL: for example usage: processInstanceBusinessKeyLike("%test%"). -
processInstanceBusinessKeyLikeIgnoreCase
Only select tasks with a business key like the given value The syntax is that of SQL: for example usage: processInstanceBusinessKeyLike("%test%"). This method, unlike theprocessInstanceBusinessKeyLike(String)
method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the query is executed. -
executionId
Only select tasks for the given execution. -
caseInstanceId
Only select tasks for the given case instance. -
caseDefinitionId
Only select tasks for the given case definition. -
caseDefinitionKey
Only select tasks which are part of a case instance which has the given case definition key. -
caseDefinitionKeyLike
Only select tasks which are part of a case instance which has a case definition key like the given value. The syntax that should be used is the same as in SQL, eg. %test%. -
caseDefinitionKeyLikeIgnoreCase
Only select tasks which are part of a case instance which has a case definition key like the given value. The syntax that should be used is the same as in SQL, eg. %test%. This method, unlike thecaseDefinitionKeyLike(String)
method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the query is executed. -
caseDefinitionKeyIn
Only select tasks that have a case definition for which the key is present in the given list -
planItemInstanceId
Only select tasks for the given plan item instance. -
scopeId
Only select tasks for the given scope identifier. -
subScopeId
Only select tasks for the given sub scope identifier. -
scopeType
Only select tasks for the given scope type. -
scopeDefinitionId
Only select tasks for the given scope definition identifier. -
propagatedStageInstanceId
Only select tasks for the given stage, defined through its stage instance id. -
processInstanceIdWithChildren
Select all tasks for the given process instance id and its children. -
caseInstanceIdWithChildren
Select all tasks for the given case instance id and its children. -
taskCreatedOn
Only select tasks that are created on the given date. -
taskCreatedBefore
Only select tasks that are created before the given date. -
taskCreatedAfter
Only select tasks that are created after the given date. -
taskInProgressStartTimeOn
Only select tasks that are started in progress on the given date. -
taskInProgressStartTimeBefore
Only select tasks that are started in progress before the given date. -
taskInProgressStartTimeAfter
Only select tasks that are started in progress after the given date. -
taskInProgressStartedBy
Select all tasks that have an in progress started user reference for the given value. -
taskClaimedOn
Only select tasks that are claimed on the given date. -
taskClaimedBefore
Only select tasks that are claimed before the given date. -
taskClaimedAfter
Only select tasks that are claimed after the given date. -
taskClaimedBy
Select all tasks that have a claimed by user reference for the given value. -
taskSuspendedOn
Only select tasks that are suspended on the given date. -
taskSuspendedBefore
Only select tasks that are suspended before the given date. -
taskSuspendedAfter
Only select tasks that are suspended after the given date. -
taskSuspendedBy
Select all tasks that have a suspended by user reference for the given value. -
taskCategory
Only select tasks with the given category. -
taskCategoryIn
Only select tasks belonging to one of the categories in the given list.- Parameters:
taskCategoryInList
-- Throws:
org.flowable.common.engine.api.FlowableIllegalArgumentException
- When passed category list is empty ornull
or containsnull
String.
-
taskCategoryNotIn
Only select tasks with a defined category which do not belong to a category present in the given list.NOTE: This method does not return tasks without category e.g. tasks having a
null
category. To includenull
categories, usequery.or().taskCategoryNotIn(...).taskWithoutCategory().endOr()
- Parameters:
taskCategoryNotInList
-- Throws:
org.flowable.common.engine.api.FlowableIllegalArgumentException
- When passed category list is empty ornull
or containsnull String
.- See Also:
-
taskWithoutCategory
T taskWithoutCategory()Selects tasks without category.Can also be used in conjunction with other filter criteria to include tasks without category e.g. in
or
queries.- See Also:
-
taskWithFormKey
T taskWithFormKey()Only select tasks with form key. -
taskFormKey
Only select tasks with the given formKey. -
taskDefinitionKey
Only select tasks with the given taskDefinitionKey. The task definition key is the id of the userTask: <userTask id="xxx" .../> -
taskDefinitionKeyLike
Only select tasks with a taskDefinitionKey that match the given parameter. The syntax is that of SQL: for example usage: taskDefinitionKeyLike("%test%"). The task definition key is the id of the userTask: <userTask id="xxx" .../> -
taskDefinitionKeys
Only select tasks with the given taskDefinitionKeys. The task definition key is the id of the userTask: <userTask id="xxx" .../> -
taskState
Only select tasks with the given state. -
taskInProgressStartDueDate
Only select tasks with the given in progress start due date. -
taskInProgressStartDueBefore
Only select tasks which have an in progress start due date before the given date. -
taskInProgressStartDueAfter
Only select tasks which have an in progress start due date after the given date. -
withoutTaskInProgressStartDueDate
T withoutTaskInProgressStartDueDate()Only select tasks with no in progress start due date. -
taskDueDate
Only select tasks with the given due date. -
taskDueBefore
Only select tasks which have a due date before the given date. -
taskDueAfter
Only select tasks which have a due date after the given date. -
withoutTaskDueDate
T withoutTaskDueDate()Only select tasks with no due date. -
processDefinitionKey
Only select tasks which are part of a process instance which has the given process definition key. -
processDefinitionKeyLike
Only select tasks which are part of a process instance which has a process definition key like the given value. The syntax that should be used is the same as in SQL, eg. %test%. -
processDefinitionKeyLikeIgnoreCase
Only select tasks which are part of a process instance which has a process definition key like the given value. The syntax that should be used is the same as in SQL, eg. %test%. This method, unlike theprocessDefinitionKeyLike(String)
method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the query is executed. -
processDefinitionKeyIn
Only select tasks that have a process definition for which the key is present in the given list -
taskDefinitionId
Only select tasks which created from the given task definition referenced by id. -
processDefinitionId
Only select tasks which are part of a process instance which has the given process definition id. -
processDefinitionName
Only select tasks which are part of a process instance which has the given process definition name. -
processDefinitionNameLike
Only select tasks which are part of a process instance which has a process definition name like the given value. The syntax that should be used is the same as in SQL, eg. %test%. -
processCategoryIn
Only select tasks which are part of a process instance whose definition belongs to the category which is present in the given list.- Parameters:
processCategoryInList
-- Throws:
org.flowable.common.engine.api.FlowableIllegalArgumentException
- When passed category list is empty ornull
or containsnull String
.
-
processCategoryNotIn
Only select tasks which are part of a process instance whose definition does not belong to the category which is present in the given list.- Parameters:
processCategoryNotInList
-- Throws:
org.flowable.common.engine.api.FlowableIllegalArgumentException
- When passed category list is empty ornull
or containsnull String
.
-
deploymentId
Only select tasks which are part of a process instance which has the given deployment id. -
deploymentIdIn
Only select tasks which are part of a process instance which has the given deployment id. -
cmmnDeploymentId
Only select tasks which are related to a case instance for to the given deployment id. -
cmmnDeploymentIdIn
Only select tasks which are related to a case instances for the given deployment id. -
withoutScopeId
T withoutScopeId()Only select tasks which don't have a scope id set. -
taskVariableValueEquals
Only select tasks which have a local task variable with the given name set to the given value. -
taskVariableValueEquals
Only select tasks which have at least one local task variable with the given value. -
taskVariableValueEqualsIgnoreCase
Only select tasks which have a local string variable with the given value, case insensitive.This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).
-
taskVariableValueNotEquals
Only select tasks which have a local task variable with the given name, but with a different value than the passed value. Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported. -
taskVariableValueNotEqualsIgnoreCase
Only select tasks which have a local string variable with is not the given value, case insensitive.This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).
-
taskVariableValueGreaterThan
Only select tasks which have a local variable value greater than the passed value when they ended. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
taskVariableValueGreaterThanOrEqual
Only select tasks which have a local variable value greater than or equal to the passed value when they ended. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
taskVariableValueLessThan
Only select tasks which have a local variable value less than the passed value when the ended.Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
taskVariableValueLessThanOrEqual
Only select tasks which have a local variable value less than or equal to the passed value when they ended. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
taskVariableValueLike
Only select tasks which have a local variable value like the given value when they ended. This can be used on string variables only.- Parameters:
name
- cannot be null.value
- cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
-
taskVariableValueLikeIgnoreCase
Only select tasks which have a local variable value like the given value (case insensitive) when they ended. This can be used on string variables only.- Parameters:
name
- cannot be null.value
- cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
-
taskVariableExists
Only select tasks which have a local variable with the given name.- Parameters:
name
- cannot be null.
-
taskVariableNotExists
Only select tasks which does not have a local variable with the given name.- Parameters:
name
- cannot be null.
-
processVariableValueEquals
Only select tasks which are part of a process that has a variable with the given name set to the given value. -
processVariableValueEquals
Only select tasks which are part of a process that has at least one variable with the given value. -
processVariableValueEqualsIgnoreCase
Only select tasks which are part of a process that has a local string variable which is not the given value, case insensitive.This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).
-
processVariableValueNotEquals
Only select tasks which have a variable with the given name, but with a different value than the passed value. Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported. -
processVariableValueNotEqualsIgnoreCase
Only select tasks which are part of a process that has a string variable with the given value, case insensitive.This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).
-
processVariableValueGreaterThan
Only select tasks which have a global variable value greater than the passed value when they ended. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
processVariableValueGreaterThanOrEqual
Only select tasks which have a global variable value greater than or equal to the passed value when they ended. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
processVariableValueLessThan
Only select tasks which have a global variable value less than the passed value when the ended.Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
processVariableValueLessThanOrEqual
Only select tasks which have a global variable value less than or equal to the passed value when they ended. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
processVariableValueLike
Only select tasks which have a global variable value like the given value when they ended. This can be used on string variables only.- Parameters:
name
- cannot be null.value
- cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
-
processVariableValueLikeIgnoreCase
Only select tasks which have a global variable value like the given value (case insensitive) when they ended. This can be used on string variables only.- Parameters:
name
- cannot be null.value
- cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
-
processVariableExists
Only select tasks which have a global variable with the given name.- Parameters:
name
- cannot be null.
-
processVariableNotExists
Only select tasks which does not have a global variable with the given name.- Parameters:
name
- cannot be null.
-
caseVariableValueEquals
Only select tasks which are part of a case that has a variable with the given name set to the given value. -
caseVariableValueEquals
Only select tasks which are part of a case that has at least one variable with the given value. -
caseVariableValueEqualsIgnoreCase
Only select tasks which are part of a case that has a local string variable which is not the given value, case insensitive.This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).
-
caseVariableValueNotEquals
Only select tasks which have a variable with the given name, but with a different value than the passed value. Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported. -
caseVariableValueNotEqualsIgnoreCase
Only select tasks which are part of a case that has a string variable with the given value, case insensitive.This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).
-
caseVariableValueGreaterThan
Only select tasks which have a global variable value greater than the passed value when they ended. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
caseVariableValueGreaterThanOrEqual
Only select tasks which have a global variable value greater than or equal to the passed value when they ended. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
caseVariableValueLessThan
Only select tasks which have a global variable value less than the passed value when the ended.Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
caseVariableValueLessThanOrEqual
Only select tasks which have a global variable value less than or equal to the passed value when they ended. Booleans, Byte-arrays andSerializable
objects (which are not primitive type wrappers) are not supported.- Parameters:
name
- cannot be null.value
- cannot be null.
-
caseVariableValueLike
Only select tasks which have a global variable value like the given value when they ended. This can be used on string variables only.- Parameters:
name
- cannot be null.value
- cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
-
caseVariableValueLikeIgnoreCase
Only select tasks which have a global variable value like the given value (case insensitive) when they ended. This can be used on string variables only.- Parameters:
name
- cannot be null.value
- cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
-
caseVariableExists
Only select tasks which have a global variable with the given name.- Parameters:
name
- cannot be null.
-
caseVariableNotExists
Only select tasks which does not have a global variable with the given name.- Parameters:
name
- cannot be null.
-
taskRootScopeId
Only selects tasks which with the given root scope id -
taskParentScopeId
Only selects tasks which with the given parent scope id -
includeTaskLocalVariables
T includeTaskLocalVariables()Include local task variables in the task query result -
includeProcessVariables
T includeProcessVariables()Include global process variables in the task query result -
includeCaseVariables
T includeCaseVariables()Include global case variables in the task query result -
includeIdentityLinks
T includeIdentityLinks()Include identity links in the task query result -
locale
Localize task name and description to specified locale. -
withLocalizationFallback
T withLocalizationFallback()Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found. -
or
T or()All query clauses called will be added to a single or-statement. This or-statement will be included with the other already existing clauses in the query, joined by an 'and'.Calling endOr() will add all clauses to the regular query again. Calling or() after or() has been called or calling endOr() after endOr() has been called will result in an exception. It is possible to call or() endOr() several times if each or() has a matching endOr(), e.g.:
query.<ConditionA>
.or().<conditionB>.<conditionC>.endOr()
.<conditionD>.<conditionE>
.or().<conditionF>.<conditionG>.endOr()
will result in: conditionA & (conditionB | conditionC) & conditionD & conditionE & (conditionF | conditionG)
-
endOr
T endOr() -
orderByTaskId
T orderByTaskId()Order by task id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTaskName
T orderByTaskName()Order by task name (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTaskDescription
T orderByTaskDescription()Order by description (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTaskPriority
T orderByTaskPriority()Order by priority (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTaskAssignee
T orderByTaskAssignee()Order by assignee (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTaskCreateTime
T orderByTaskCreateTime()Order by the time on which the tasks were created (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessInstanceId
T orderByProcessInstanceId()Order by process instance id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByExecutionId
T orderByExecutionId()Order by execution id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByProcessDefinitionId
T orderByProcessDefinitionId()Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTaskDueDate
T orderByTaskDueDate()Order by task due date (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTaskOwner
T orderByTaskOwner()Order by task owner (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTaskDefinitionKey
T orderByTaskDefinitionKey()Order by task definition key (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByTenantId
T orderByTenantId()Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). -
orderByDueDateNullsFirst
T orderByDueDateNullsFirst()Order by due date (needs to be followed byQuery.asc()
orQuery.desc()
). If any of the tasks have null for the due date, these will be first in the result. -
orderByDueDateNullsLast
T orderByDueDateNullsLast()Order by due date (needs to be followed byQuery.asc()
orQuery.desc()
). If any of the tasks have null for the due date, these will be last in the result. -
orderByCategory
T orderByCategory()Order by category (needs to be followed byQuery.asc()
orQuery.desc()
).
-