Class TaskQuery.FilterQuery
- All Implemented Interfaces:
TaskQuery.IFilterableColumns
,TaskQuery.IFilterLink
,TaskQuery.IFilterQuery
- Enclosing class:
- TaskQuery
- API:
- This is a public API.
-
Nested Class Summary
Nested classes/interfaces inherited from class ch.ivyteam.ivy.workflow.query.TaskQuery
TaskQuery.AggregationQuery, TaskQuery.FilterLink, TaskQuery.FilterQuery, TaskQuery.GroupByQuery, TaskQuery.IAggregationQuery, TaskQuery.IBooleanColumnFilterQuery, TaskQuery.IBoolFilterQuery, TaskQuery.IClobColumnFilterQuery, TaskQuery.IColumnFilterQuery, TaskQuery.ICustomFieldAggregationQuery, TaskQuery.ICustomFieldFilterQuery, TaskQuery.ICustomFieldGroupBy, TaskQuery.ICustomFieldOrderBy, TaskQuery.IDateColumnFilterQuery, TaskQuery.IFilterableColumns, TaskQuery.IFilterLink, TaskQuery.IFilterQuery, TaskQuery.IGroupByQueryColumns, TaskQuery.IIntegerColumnFilterQuery, TaskQuery.INumberColumnFilterQuery, TaskQuery.IOrderByQueryColumns, TaskQuery.IPatternColumnFilterQuery, TaskQuery.IStringColumnFilterQuery, TaskQuery.ITaskStateFilterQuery, TaskQuery.IWorkflowPriorityFilterQuery, TaskQuery.OrderByColumnQuery, TaskQuery.OrderByQuery
-
Method Summary
Modifier and TypeMethodDescriptionPrepares a where statement for the columnActivatorDisplayName
.
Must be followed by a call to a condition method.Prepares a where statement for the columnActivatorId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnActivatorName
.
Must be followed by a call to a condition method.additionalProperty
(String key) Deprecated.Prepares a where statement for the columnApplicationId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnBusinessCalendar
.
Must be followed by a call to a condition method.Prepares a where statement for the columnBusinessCaseId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnBusinessRuntime
.
Must be followed by a call to a condition method.canWorkOn
(ISecurityMember member) Filters all tasks the given security member (user or role) can now work on.Filters all tasks where the security member with given member name (user or role) in the given application can now work on.
Compared to the methodcanWorkOn(ISecurityMember)
, this method evaluates the correspondingISecurityMember
on query execution.caseId()
Prepares a where statement for the columnCaseId
.
Must be followed by a call to a condition method.Adds an expression to the where clause that selects those tasks that belong to cases which matches the givencaseQuery
.category()
Prepares a where statement for the columnCategory
.
Must be followed by a call to a condition method.Filters all tasks the current session user can now work on.Filters all tasks the current session user has worked on.Filters all tasks the user of the current session user is involved in.Prepares a where statement for a custom field.
Must be followed by a call to a field value type.Prepares a where statement for the columnDelayTimestamp
.
Must be followed by a call to a condition method.Prepares a where statement for the columnDescription
.
Must be followed by a call to a condition method.Prepares a where statement for the columnEndTaskSwitchEventId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnEndTimestamp
.
Must be followed by a call to a condition method.Prepares a where statement for the columnExpiredCreatorTaskId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnExpiryActivatorDisplayName
.
Must be followed by a call to a condition method.Prepares a where statement for the columnExpiryActivatorId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnExpiryActivatorName
.
Must be followed by a call to a condition method.Prepares a where statement for the columnExpiryPriority
.
Must be followed by a call to a condition method.Prepares a where statement for the columnExpiryTaskStartElementPid
.
Must be followed by a call to a condition method.Prepares a where statement for the columnExpiryTimestamp
.
Must be followed by a call to a condition method.Prepares a where statement for the columnFailedTimeoutTimestamp
.
Must be followed by a call to a condition method.hasWorkedOn
(ISecurityMember member) Filters all tasks the given security member (user or role) has worked on.hasWorkedOn
(String memberName, String applicationName) Filters all tasks where the security member with given member name (user or role) in the given application has worked on.
Compared to the methodhasWorkedOn(ISecurityMember)
, this method evaluates the correspondingISecurityMember
on query execution.haveTriggeredCases
(CaseQuery caseQuery) Adds an expression to the where clause that selects those tasks that have triggered the creation of cases which matches the givencaseQuery
.Prepares a where statement for the columnIsExpired
.
Must be followed by a call to a condition method.isInvolved
(ISecurityMember member) Filters all tasks the security member is involved in.
If the given security member is a user, this method is equivalent toTaskQuery.IFilterableColumns.userIsInvolved(ch.ivyteam.ivy.security.IUser)
. If the given security member is a role, this method is equivalent toTaskQuery.IFilterableColumns.roleIsInvolved(ch.ivyteam.ivy.security.IRole)
.isInvolved
(String memberName, String applicationName) Filters all tasks where the security member with given member name (user or role) in the given application is involved in.Prepares a where statement for the columnIsOffline
.
Must be followed by a call to a condition method.Prepares a where statement for the columnIsUpdatedOnStart
.
Must be followed by a call to a condition method.Prepares a where statement for the columnLanguageId
.
Must be followed by a call to a condition method.name()
Prepares a where statement for the columnName
.
Must be followed by a call to a condition method.Adds a condition, which negates a set of where conditions given by theotherQuery
with a NOT expression.
Only the where clause of the givenotherQuery
is considered.Prepares a where statement for the columnNumberOfFailures
.
Must be followed by a call to a condition method.Prepares a where statement for the columnNumberOfResumes
.
Must be followed by a call to a condition method.Prepares a where statement for the columnOriginalActivatorDisplayName
.
Must be followed by a call to a condition method.Prepares a where statement for the columnOriginalActivatorId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnOriginalActivatorName
.
Must be followed by a call to a condition method.Prepares a where statement for the columnOriginalPriority
.
Must be followed by a call to a condition method.priority()
Prepares a where statement for the columnPriority
.
Must be followed by a call to a condition method.Prepares a where statement for the columnProcessModelId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnRequestPath
.
Must be followed by a call to a condition method.roleIsInvolved
(IRole role) Filters all tasks the role is involved in.roleIsInvolved
(String roleName, String applicationName) Filters all tasks where the role with given name in the given application is involved in.Prepares a where statement for the columnSecuritySystemId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnStartTaskSwitchEventId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnStartTimestamp
.
Must be followed by a call to a condition method.state()
Prepares a where statement for the columnState
.
Must be followed by a call to a condition method.Prepares a where statement for the columnTaskEndId
.
Must be followed by a call to a condition method.taskId()
Prepares a where statement for the columnTaskId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnTaskStartId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnTimeoutedCreatorIntrmdtEventId
.
Must be followed by a call to a condition method.userIsInvolved
(IUser user) Filters all tasks the user is involved in.userIsInvolved
(String userName, String applicationName) Filters all tasks where the user with given name in the given application is involved in.workerId()
Prepares a where statement for the columnWorkerId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnWorkerSessionId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnWorkerUserDisplayName
.
Must be followed by a call to a condition method.Prepares a where statement for the columnWorkerUserName
.
Must be followed by a call to a condition method.Prepares a where statement for the columnWorkingTime
.
Must be followed by a call to a condition method.Methods inherited from class ch.ivyteam.ivy.workflow.query.TaskQuery.FilterLink
and, and, andOverall, andOverall, or, or
Methods inherited from class ch.ivyteam.ivy.workflow.query.TaskQuery
aggregate, create, executor, groupBy, orderBy, where
Methods inherited from interface ch.ivyteam.ivy.workflow.query.TaskQuery.IFilterLink
and, and, andOverall, andOverall, or, or
-
Method Details
-
cases
Description copied from interface:TaskQuery.IFilterableColumns
Adds an expression to the where clause that selects those tasks that belong to cases which matches the given
caseQuery
.This method considers only the where clause of the given
caseQuery
. All other parts are ignored.Example:
Get all tasks that belong to cases with the custom varchar field1 set to "HRM"import ITask; import ch.ivyteam.ivy.workflow.TaskState; import ch.ivyteam.ivy.workflow.query.TaskQuery; import ch.ivyteam.ivy.workflow.query.CaseQuery; TaskQuery query = TaskQuery.create().where().cases(CaseQuery.create().where().customVarCharField1().isEqual("HRM")); List<ITask> tasksWithBelongToHrmCases = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
cases
in interfaceTaskQuery.IFilterableColumns
- Parameters:
caseQuery
- case query with where clause to filter the cases- Returns:
- the query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
haveTriggeredCases
Description copied from interface:TaskQuery.IFilterableColumns
Adds an expression to the where clause that selects those tasks that have triggered the creation of cases which matches the given
caseQuery
.Tasks can trigger the creation of cases by using the Trigger process element.
This method considers only the where clause of the given
caseQuery
. All other parts are ignoredExample:
Get all tasks that have created cases with the custom varchar field1 set to "HRM"import ITask; import ch.ivyteam.ivy.workflow.TaskState; import ch.ivyteam.ivy.workflow.query.TaskQuery; import ch.ivyteam.ivy.workflow.query.CaseQuery; TaskQuery query = TaskQuery.create().where().haveTriggeredCases(CaseQuery.create().where().customVarCharField1().isEqual("HRM")); List<ITask> tasksThatTriggeredHrmCases = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
haveTriggeredCases
in interfaceTaskQuery.IFilterableColumns
- Parameters:
caseQuery
- case query with where clause to filter the cases- Returns:
- the query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
isInvolved
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks the security member is involved in.
- If the given security member is a user, this method is equivalent to
TaskQuery.IFilterableColumns.userIsInvolved(ch.ivyteam.ivy.security.IUser)
. - If the given security member is a role, this method is equivalent to
TaskQuery.IFilterableColumns.roleIsInvolved(ch.ivyteam.ivy.security.IRole)
.
- Specified by:
isInvolved
in interfaceTaskQuery.IFilterableColumns
- Returns:
- the query for further composition
- See Also:
-
CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
CaseQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.currentUserIsInvolved()
TaskQuery.IFilterableColumns.userIsInvolved(ch.ivyteam.ivy.security.IUser)
TaskQuery.IFilterableColumns.userIsInvolved(String, String)
TaskQuery.IFilterableColumns.roleIsInvolved(ch.ivyteam.ivy.security.IRole)
TaskQuery.IFilterableColumns.roleIsInvolved(String, String)
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
- If the given security member is a user, this method is equivalent to
-
currentUserIsInvolved
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks the user of the current session user is involved in.
Example:
import ch.ivyteam.ivy.workflow.query.TaskQuery; import ch.ivyteam.ivy.workflow.ITask; TaskQuery query = TaskQuery.create().where().currentUserIsInvolved(); List<ITask> tasksSessionIsInvolved = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
currentUserIsInvolved
in interfaceTaskQuery.IFilterableColumns
- Returns:
- the query for further composition
- See Also:
-
CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
CaseQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.isInvolved(ISecurityMember)
TaskQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.userIsInvolved(ch.ivyteam.ivy.security.IUser)
TaskQuery.IFilterableColumns.userIsInvolved(String, String)
TaskQuery.IFilterableColumns.roleIsInvolved(ch.ivyteam.ivy.security.IRole)
TaskQuery.IFilterableColumns.roleIsInvolved(String, String)
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
isInvolved
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks where the security member with given member name (user or role) in the given application is involved in.Compared to the method
isInvolved(ISecurityMember)
, this method evaluates the correspondingISecurityMember
on query execution.Example:
Get all tasks where the current user or the user 'UserHans' is involved in:import ch.ivyteam.ivy.workflow.ITask; import ch.ivyteam.ivy.workflow.query.TaskQuery; TaskQuery query = TaskQuery.create() .where().isInvolved("#UserHans", "MyApp") // note: to convert a user name to a member name a '#' is added as prefix .or().isInvolved(ivy.session.getSessionUser().getMemberName(), "MyApp"); List<ITask> tasks = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
isInvolved
in interfaceTaskQuery.IFilterableColumns
- Parameters:
memberName
- e.g. "#UserHans" or "TopManagementRole"applicationName
- e.g. "MyApplication"- Returns:
- the query for further composition
- See Also:
-
CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
CaseQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.isInvolved(ISecurityMember)
TaskQuery.IFilterableColumns.currentUserIsInvolved()
TaskQuery.IFilterableColumns.userIsInvolved(ch.ivyteam.ivy.security.IUser)
TaskQuery.IFilterableColumns.userIsInvolved(String, String)
TaskQuery.IFilterableColumns.roleIsInvolved(ch.ivyteam.ivy.security.IRole)
TaskQuery.IFilterableColumns.roleIsInvolved(String, String)
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
userIsInvolved
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks where the user with given name in the given application is involved in.Compared to the method
userIsInvolved(IUser)
, this method evaluates the correspondingIUser
on query execution.This method is equivalent to
isInvolved("#" + userName, applicationName)
- Specified by:
userIsInvolved
in interfaceTaskQuery.IFilterableColumns
- Parameters:
userName
- e.g. "UserHans"- Returns:
- the query for further composition
- See Also:
-
CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
CaseQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.isInvolved(ISecurityMember)
TaskQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.currentUserIsInvolved()
TaskQuery.IFilterableColumns.userIsInvolved(ch.ivyteam.ivy.security.IUser)
TaskQuery.IFilterableColumns.roleIsInvolved(ch.ivyteam.ivy.security.IRole)
TaskQuery.IFilterableColumns.roleIsInvolved(String, String)
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
roleIsInvolved
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks where the role with given name in the given application is involved in.Compared to the method
roleIsInvolved(IRole)
, this method evaluates the correspondingIRole
on query execution.This method is equivalent to
TaskQuery.IFilterableColumns.isInvolved(String, String)
- Specified by:
roleIsInvolved
in interfaceTaskQuery.IFilterableColumns
- Parameters:
roleName
- e.g. "TopManagementRole"- Returns:
- the query for further composition@see CaseQuery.IFilterQuery#isInvolved(ISecurityMember)
- See Also:
-
CaseQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.isInvolved(ISecurityMember)
TaskQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.currentUserIsInvolved()
TaskQuery.IFilterableColumns.userIsInvolved(ch.ivyteam.ivy.security.IUser)
TaskQuery.IFilterableColumns.userIsInvolved(String, String)
TaskQuery.IFilterableColumns.roleIsInvolved(ch.ivyteam.ivy.security.IRole)
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
roleIsInvolved
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks the role is involved in. A role is involved in a task if
- the task is assigned to the role. Either before or after the expiry.
- the role becomes responsible for a task after expiry but the task has not yet expired.
- the task is assigned to the role but is
delayed
- the task is assigned to a sub or parent role of the role
Example:
import ch.ivyteam.ivy.workflow.query.TaskQuery; import ch.ivyteam.ivy.workflow.ITask; import ch.ivyteam.ivy.security.IRole; IRole role = ivy.session.getSecurityContext().findRole("Admin"); TaskQuery query = TaskQuery.create().where().roleIsInvolved(role); List<ITask> userInvolvedTasks = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
roleIsInvolved
in interfaceTaskQuery.IFilterableColumns
- Returns:
- the query for further composition
- See Also:
-
CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
CaseQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.isInvolved(ISecurityMember)
TaskQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.currentUserIsInvolved()
TaskQuery.IFilterableColumns.userIsInvolved(ch.ivyteam.ivy.security.IUser)
TaskQuery.IFilterableColumns.userIsInvolved(String, String)
TaskQuery.IFilterableColumns.roleIsInvolved(String, String)
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
userIsInvolved
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks the user is involved in. A user is involved in a task if
- the user could work on the task
- the user is working at the task right now
- the user has completed the task
- the user has worked on the task without completing it and now it is no longer accessible for him. Either because the task was completed by someone else, was reassigned, ...
- the user can work on the task but it is
delayed
Example:
import ch.ivyteam.ivy.workflow.query.TaskQuery; import ch.ivyteam.ivy.workflow.ITask; import ch.ivyteam.ivy.security.IUser; IUser user = ivy.session.getSessionUser(); TaskQuery query = TaskQuery.create().where().userIsInvolved(user); List<ITask> userInvolvedTasks = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
userIsInvolved
in interfaceTaskQuery.IFilterableColumns
- Returns:
- the query for further composition
- See Also:
-
CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
CaseQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.isInvolved(ISecurityMember)
TaskQuery.IFilterableColumns.isInvolved(String, String)
TaskQuery.IFilterableColumns.currentUserIsInvolved()
TaskQuery.IFilterableColumns.userIsInvolved(String, String)
TaskQuery.IFilterableColumns.roleIsInvolved(ch.ivyteam.ivy.security.IRole)
TaskQuery.IFilterableColumns.roleIsInvolved(String, String)
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
canWorkOn
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks the given security member (user or role) can now work on.
Example:
import ch.ivyteam.ivy.workflow.query.TaskQuery; import ch.ivyteam.ivy.workflow.ITask; import ch.ivyteam.ivy.security.IUser; IUser user = ivy.session.getSessionUser(); TaskQuery query = TaskQuery.create().where().canWorkOn(user); List<ITask> tasksUserCanWorkOn = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
canWorkOn
in interfaceTaskQuery.IFilterableColumns
- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
canWorkOn
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks where the security member with given member name (user or role) in the given application can now work on.
Compared to the methodcanWorkOn(ISecurityMember)
, this method evaluates the correspondingISecurityMember
on query execution.Example:
Get all tasks where the current user or the user 'UserHans' can work on:import ch.ivyteam.ivy.workflow.ITask; import ch.ivyteam.ivy.workflow.query.TaskQuery; TaskQuery query = TaskQuery.create() .where().canWorkOn("#UserHans", "MyApp") // note: to convert a user name to a member name a '#' is added as prefix .or().canWorkOn(ivy.session.getSessionUser().getMemberName(), "MyApp"); List<ITask> tasks = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
canWorkOn
in interfaceTaskQuery.IFilterableColumns
- Parameters:
memberName
- e.g. "#UserHans" or "TopManagementRole"applicationName
- e.g. "MyApplication"- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
currentUserCanWorkOn
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks the current session user can now work on.
Example:
import ch.ivyteam.ivy.workflow.query.TaskQuery; import ch.ivyteam.ivy.workflow.ITask; TaskQuery query = TaskQuery.create().where().currentUserCanWorkOn(); List<ITask> tasksSessionCanWorkOn = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
currentUserCanWorkOn
in interfaceTaskQuery.IFilterableColumns
- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
hasWorkedOn
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks the given security member (user or role) has worked on.
Example:
import ch.ivyteam.ivy.workflow.query.TaskQuery; import ch.ivyteam.ivy.workflow.ITask; import ch.ivyteam.ivy.security.IUser; IUser user = ivy.session.getSessionUser(); TaskQuery query = TaskQuery.create().where().hasWorkedOn(user); List<ITask> tasksUserHasWorkedOn = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
hasWorkedOn
in interfaceTaskQuery.IFilterableColumns
- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
hasWorkedOn
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks where the security member with given member name (user or role) in the given application has worked on.
Compared to the methodhasWorkedOn(ISecurityMember)
, this method evaluates the correspondingISecurityMember
on query execution.Example:
Get all tasks where the current user or the user 'UserHans' has worked on:import ch.ivyteam.ivy.workflow.ITask; import ch.ivyteam.ivy.workflow.query.TaskQuery; TaskQuery query = TaskQuery.create() .where().hasWorkedOn("#UserHans", "MyApp") // note: to convert a user name to a member name a '#' is added as prefix .or().hasWorkedOn(ivy.session.getSessionUser().getMemberName(), "MyApp"); List<ITask> tasks = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
hasWorkedOn
in interfaceTaskQuery.IFilterableColumns
- Parameters:
memberName
- e.g. "#UserHans" or "TopManagementRole"applicationName
- e.g. "MyApplication"- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
currentUserHasWorkedOn
Description copied from interface:TaskQuery.IFilterableColumns
Filters all tasks the current session user has worked on.
Example:
import ch.ivyteam.ivy.workflow.query.TaskQuery; import ch.ivyteam.ivy.workflow.ITask; TaskQuery query = TaskQuery.create().where().currentUserHasWorkedOn(); List<ITask> tasksSessionHasWorkedOn = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
currentUserHasWorkedOn
in interfaceTaskQuery.IFilterableColumns
- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
customField
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for a custom field.
Must be followed by a call to a field value type.Example:
import ch.ivyteam.ivy.workflow.ITask; import ch.ivyteam.ivy.workflow.query.TaskQuery; TaskQuery query = TaskQuery.create().where().customField().stringField("myCustomField").isEqualTo("valueToFind")"; List<ITask> tasksWithMatchingField = ivy.wf.getTaskQueryExecutor().getResults(query);
- Specified by:
customField
in interfaceTaskQuery.IFilterableColumns
- Returns:
- the query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
additionalProperty
Deprecated.Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for an additional property value.
Must be followed by a call to a condition method.- Specified by:
additionalProperty
in interfaceTaskQuery.IFilterableColumns
- Parameters:
key
- the additional property key- Returns:
- the query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
not
Adds a condition, which negates a set of where conditions given by the
otherQuery
with a NOT expression.
Only the where clause of the givenotherQuery
is considered. All other parts are ignored.SQL part:
NOT([otherSqlExpression])
Example:
Corresponds to SQL:TaskQuery subQuery = TaskQuery.create().where() .customVarCharField1().equals("a").or() .customVarCharField2().equals("b") TaskQuery query = TaskQuery.create().where() .not(subQuery)
SELECT * FROM IWA_IWA_Task WHERE NOT( customVarCharField1 = 'a' OR customVarCharField2 = 'b')
- Specified by:
not
in interfaceTaskQuery.IFilterableColumns
- Parameters:
otherQuery
- Query from which the negated where part will be added to the current query.- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
taskId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
TaskId
.
Must be followed by a call to a condition method.- Specified by:
taskId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
caseId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
CaseId
.
Must be followed by a call to a condition method.- Specified by:
caseId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
businessCaseId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
BusinessCaseId
.
Must be followed by a call to a condition method.- Specified by:
businessCaseId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
processModelId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ProcessModelId
.
Must be followed by a call to a condition method.- Specified by:
processModelId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
securitySystemId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
SecuritySystemId
.
Must be followed by a call to a condition method.- Specified by:
securitySystemId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
applicationId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ApplicationId
.
Must be followed by a call to a condition method.- Specified by:
applicationId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
startTaskSwitchEventId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
StartTaskSwitchEventId
.
Must be followed by a call to a condition method.- Specified by:
startTaskSwitchEventId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
endTaskSwitchEventId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
EndTaskSwitchEventId
.
Must be followed by a call to a condition method.- Specified by:
endTaskSwitchEventId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
taskStartId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
TaskStartId
.
Must be followed by a call to a condition method.- Specified by:
taskStartId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
taskEndId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
TaskEndId
.
Must be followed by a call to a condition method.- Specified by:
taskEndId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
workerId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
WorkerId
.
Must be followed by a call to a condition method.- Specified by:
workerId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
workerUserName
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
WorkerUserName
.
Must be followed by a call to a condition method.This is a virtual column. It contains the same value as the column
Name
of the referencedWorker
.- Specified by:
workerUserName
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
workerUserDisplayName
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
WorkerUserDisplayName
.
Must be followed by a call to a condition method.This is a virtual column. It contains the same value as the column
DisplayName
of the referencedWorker
.- Specified by:
workerUserDisplayName
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
workerSessionId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
WorkerSessionId
.
Must be followed by a call to a condition method.- Specified by:
workerSessionId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
activatorId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ActivatorId
.
Must be followed by a call to a condition method.- Specified by:
activatorId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
originalActivatorId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
OriginalActivatorId
.
Must be followed by a call to a condition method.- Specified by:
originalActivatorId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
originalActivatorName
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
OriginalActivatorName
.
Must be followed by a call to a condition method.This is a virtual column. It contains the same value as the column
MemberName
of the referencedOriginalActivator
.- Specified by:
originalActivatorName
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
originalActivatorDisplayName
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
OriginalActivatorDisplayName
.
Must be followed by a call to a condition method.This is a virtual column. It contains the same value as the column
DisplayName
of the referencedOriginalActivator
.- Specified by:
originalActivatorDisplayName
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
expiryActivatorId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ExpiryActivatorId
.
Must be followed by a call to a condition method.- Specified by:
expiryActivatorId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
expiryActivatorName
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ExpiryActivatorName
.
Must be followed by a call to a condition method.This is a virtual column. It contains the same value as the column
MemberName
of the referencedExpiryActivator
.- Specified by:
expiryActivatorName
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
expiryActivatorDisplayName
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ExpiryActivatorDisplayName
.
Must be followed by a call to a condition method.This is a virtual column. It contains the same value as the column
DisplayName
of the referencedExpiryActivator
.- Specified by:
expiryActivatorDisplayName
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
expiryPriority
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ExpiryPriority
.
Must be followed by a call to a condition method.- Specified by:
expiryPriority
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
expiryTimestamp
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ExpiryTimestamp
.
Must be followed by a call to a condition method.- Specified by:
expiryTimestamp
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
expiryTaskStartElementPid
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ExpiryTaskStartElementPid
.
Must be followed by a call to a condition method.- Specified by:
expiryTaskStartElementPid
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
isExpired
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
IsExpired
.
Must be followed by a call to a condition method.- Specified by:
isExpired
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
expiredCreatorTaskId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ExpiredCreatorTaskId
.
Must be followed by a call to a condition method.- Specified by:
expiredCreatorTaskId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
timeoutedCreatorIntrmdtEventId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
TimeoutedCreatorIntrmdtEventId
.
Must be followed by a call to a condition method.- Specified by:
timeoutedCreatorIntrmdtEventId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
delayTimestamp
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
DelayTimestamp
.
Must be followed by a call to a condition method.- Specified by:
delayTimestamp
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
state
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
State
.
Must be followed by a call to a condition method.- Specified by:
state
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
requestPath
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
RequestPath
.
Must be followed by a call to a condition method.- Specified by:
requestPath
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
name
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
Name
.
Must be followed by a call to a condition method.This is a virtual column. It contains the same value as the column
Name
of the referencedTaskLocalized
.- Specified by:
name
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
description
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
Description
.
Must be followed by a call to a condition method.This is a virtual column. It contains the same value as the column
Description
of the referencedTaskLocalized
.- Specified by:
description
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
priority
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
Priority
.
Must be followed by a call to a condition method.- Specified by:
priority
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
originalPriority
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
OriginalPriority
.
Must be followed by a call to a condition method.- Specified by:
originalPriority
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
startTimestamp
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
StartTimestamp
.
Must be followed by a call to a condition method.- Specified by:
startTimestamp
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
endTimestamp
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
EndTimestamp
.
Must be followed by a call to a condition method.- Specified by:
endTimestamp
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
businessCalendar
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
BusinessCalendar
.
Must be followed by a call to a condition method.- Specified by:
businessCalendar
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
workingTime
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
WorkingTime
.
Must be followed by a call to a condition method.- Specified by:
workingTime
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
businessRuntime
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
BusinessRuntime
.
Must be followed by a call to a condition method.- Specified by:
businessRuntime
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
failedTimeoutTimestamp
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
FailedTimeoutTimestamp
.
Must be followed by a call to a condition method.- Specified by:
failedTimeoutTimestamp
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
numberOfFailures
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
NumberOfFailures
.
Must be followed by a call to a condition method.- Specified by:
numberOfFailures
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
numberOfResumes
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
NumberOfResumes
.
Must be followed by a call to a condition method.- Specified by:
numberOfResumes
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
category
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
Category
.
Must be followed by a call to a condition method.- Specified by:
category
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
isUpdatedOnStart
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
IsUpdatedOnStart
.
Must be followed by a call to a condition method.- Specified by:
isUpdatedOnStart
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
isOffline
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
IsOffline
.
Must be followed by a call to a condition method.- Specified by:
isOffline
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
activatorName
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ActivatorName
.
Must be followed by a call to a condition method.This is a virtual column. It contains the same value as the column
MemberName
of the referencedActivator
.- Specified by:
activatorName
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
activatorDisplayName
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
ActivatorDisplayName
.
Must be followed by a call to a condition method.This is a virtual column. It contains the same value as the column
DisplayName
of the referencedActivator
.- Specified by:
activatorDisplayName
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
languageId
Description copied from interface:TaskQuery.IFilterableColumns
Prepares a where statement for the column
LanguageId
.
Must be followed by a call to a condition method.This is a virtual column. It contains the same value as the column
LanguageId
of the referencedTaskLocalized
.- Specified by:
languageId
in interfaceTaskQuery.IFilterableColumns
- Returns:
- query for further composition
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-