Package ch.ivyteam.ivy.workflow.query

Class TaskQuery.FilterQuery

java.lang.Object

ch.ivyteam.ivy.persistence.query.Query<ITask>

ch.ivyteam.ivy.workflow.query.TaskQuery

ch.ivyteam.ivy.workflow.query.TaskQuery.FilterLink

ch.ivyteam.ivy.workflow.query.TaskQuery.FilterQuery

All Implemented Interfaces:

TaskQuery.IFilterableColumns, TaskQuery.IFilterLink, TaskQuery.IFilterQuery

Enclosing class:

TaskQuery

public class TaskQuery.FilterQuery
extends TaskQuery.FilterLink
implements TaskQuery.IFilterQuery

API:

This is a public API.

Nested Class Summary

Nested classes/interfaces inherited from class ch.ivyteam.ivy.workflow.query.TaskQuery

TaskQuery.AggregationQuery, TaskQuery.EnumValueOrderByColumnQuery<T extends ch.ivyteam.ivy.persistence.IPersistentEnumeration>, 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.ITaskBusinessStateFilterQuery, TaskQuery.ITaskStateFilterQuery, TaskQuery.IUUIDColumnFilterQuery, TaskQuery.IWorkflowPriorityFilterQuery, TaskQuery.LongValueOrderByColumnQuery, TaskQuery.OrderByColumnQuery, TaskQuery.OrderByQuery, TaskQuery.StringValueOrderByColumnQuery

Method Summary

Modifier and Type	Method	Description
TaskQuery.IStringColumnFilterQuery	additionalProperty(String key)	Deprecated.
TaskQuery.IIntegerColumnFilterQuery	businessCaseId()	Prepares a where statement for the column BusinessCaseId. Must be followed by a call to a condition method.
TaskQuery.FilterLink	canWorkOn(ISecurityMember member)	Filters all tasks the given security member (user or role) can now work on.
TaskQuery.FilterLink	canWorkOn(String memberName, String applicationName)	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 method canWorkOn(ISecurityMember), this method evaluates the corresponding ISecurityMember on query execution.
TaskQuery.FilterLink	cases(CaseQuery caseQuery)	Adds an expression to the where clause that selects those tasks that belong to cases which matches the given caseQuery.
TaskQuery.FilterLink	currentUserCanWorkOn()	Filters all tasks the current session user can now work on.
TaskQuery.FilterLink	currentUserHasWorkedOn()	Filters all tasks the current session user has worked on.
TaskQuery.FilterLink	currentUserIsInvolved()	Filters all tasks the user of the current session user is involved in.
TaskQuery.FilterLink	currentUserOrHisRolesAreInvolved()	Filters all tasks the current user or any of his roles are involved in.
TaskQuery.ICustomFieldFilterQuery	customField()	Prepares a where statement for a custom field. Must be followed by a call to a field value type.
TaskQuery.IClobColumnFilterQuery	displayDescriptionTemplate()	Deprecated, for removal: This API element is subject to removal in a future version.
TaskQuery.IStringColumnFilterQuery	displayNameTemplate()	Deprecated, for removal: This API element is subject to removal in a future version.
TaskQuery.FilterLink	hasWorkedOn(ISecurityMember member)	Filters all tasks the given security member (user or role) has worked on.
TaskQuery.FilterLink	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 method hasWorkedOn(ISecurityMember), this method evaluates the corresponding ISecurityMember on query execution.
TaskQuery.FilterLink	haveTriggeredCases(CaseQuery caseQuery)	Adds an expression to the where clause that selects those tasks that have triggered the creation of cases which matches the given caseQuery.
TaskQuery.FilterLink	isInvolved(ISecurityMember member)	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).
TaskQuery.FilterLink	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.
TaskQuery.FilterLink	roleIsInvolved(IRole role)	Filters all tasks the role is involved in.
TaskQuery.FilterLink	roleIsInvolved(String roleName, String applicationName)	Filters all tasks where the role with given name in the given application is involved in.
TaskQuery.FilterLink	userIsInvolved(IUser user)	Filters all tasks the user is involved in.
TaskQuery.FilterLink	userIsInvolved(String userName, String applicationName)	Filters all tasks where the user with given name in the given application is involved in.
TaskQuery.FilterLink	userOrHisRolesAreInvolved(IUser user)	Filters all tasks the given user or any of his roles are involved in.
TaskQuery.FilterLink	userOrHisRolesAreInvolved(String userName, String applicationName)	Filters all tasks the user with the given name in the given application or any of his roles are involved in.

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, asJson, create, executor, fromJson, groupBy, orderBy, toType, where

Methods inherited from class ch.ivyteam.ivy.persistence.query.Query

equals, hashCode

Methods inherited from interface ch.ivyteam.ivy.workflow.query.TaskQuery.IFilterLink

and, and, andOverall, andOverall, or, or

Method Details

cases

public TaskQuery.FilterLink cases(CaseQuery caseQuery)

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 interface TaskQuery.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 Java.

haveTriggeredCases

public TaskQuery.FilterLink haveTriggeredCases(CaseQuery caseQuery)

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 ignored

Example:
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 interface TaskQuery.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 Java.

isInvolved

public TaskQuery.FilterLink isInvolved(ISecurityMember member)

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 interface TaskQuery.IFilterableColumns

Parameters:

member -

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 Java.

currentUserIsInvolved

public TaskQuery.FilterLink 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 interface TaskQuery.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 Java.

currentUserOrHisRolesAreInvolved

public TaskQuery.FilterLink currentUserOrHisRolesAreInvolved()

Description copied from interface: TaskQuery.IFilterableColumns

Filters all tasks the current user or any of his roles are involved in. See TaskQuery.IFilterableColumns.currentUserIsInvolved() for a description of when the current user is involved in a task and TaskQuery.IFilterableColumns.roleIsInvolved(IRole) for when a role is involved in a task.

Specified by:

currentUserOrHisRolesAreInvolved in interface TaskQuery.IFilterableColumns

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.userOrHisRolesAreInvolved(IUser)
• TaskQuery.IFilterableColumns.userOrHisRolesAreInvolved(String, String)
• TaskQuery.IFilterableColumns.userIsInvolved(IUser)
• TaskQuery.IFilterableColumns.userIsInvolved(String, String)
• TaskQuery.IFilterableColumns.roleIsInvolved(IRole)
• TaskQuery.IFilterableColumns.roleIsInvolved(String, String)
• TaskQuery.IFilterableColumns.currentUserIsInvolved()
• CaseQuery.IFilterableColumns.currentUserOrHisRolesAreInvolved()
• CaseQuery.IFilterableColumns.userOrHisRolesAreInvolved(String, String)
• CaseQuery.IFilterableColumns.userOrHisRolesAreInvolved(IUser)

API:

This public API is available in Java.

isInvolved

public TaskQuery.FilterLink isInvolved(String memberName,
 String applicationName)

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 corresponding ISecurityMember 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 interface TaskQuery.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 Java.

userIsInvolved

public TaskQuery.FilterLink userIsInvolved(String userName,
 String applicationName)

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 corresponding IUser on query execution.

This method is equivalent to isInvolved("#" + userName, applicationName)

Specified by:

userIsInvolved in interface TaskQuery.IFilterableColumns

Parameters:

userName - e.g. "UserHans"

applicationName -

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 Java.

userOrHisRolesAreInvolved

public TaskQuery.FilterLink userOrHisRolesAreInvolved(String userName,
 String applicationName)

Description copied from interface: TaskQuery.IFilterableColumns

Filters all tasks the user with the given name in the given application or any of his roles are involved in. See TaskQuery.IFilterableColumns.userIsInvolved(IUser) for a description of when a user is involved in a task and TaskQuery.IFilterableColumns.roleIsInvolved(IRole) for when a role is involved in a task.

Specified by:

userOrHisRolesAreInvolved in interface TaskQuery.IFilterableColumns

Parameters:

userName - e.g. "Joe"

applicationName -

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.userOrHisRolesAreInvolved(IUser user)
• TaskQuery.IFilterableColumns.currentUserOrHisRolesAreInvolved()
• TaskQuery.IFilterableColumns.userIsInvolved(IUser)
• TaskQuery.IFilterableColumns.userIsInvolved(String, String)
• TaskQuery.IFilterableColumns.roleIsInvolved(IRole)
• TaskQuery.IFilterableColumns.roleIsInvolved(String, String)
• TaskQuery.IFilterableColumns.currentUserIsInvolved()
• CaseQuery.IFilterableColumns.userOrHisRolesAreInvolved(String, String)
• CaseQuery.IFilterableColumns.userOrHisRolesAreInvolved(IUser)
• CaseQuery.IFilterableColumns.currentUserOrHisRolesAreInvolved()

API:

This public API is available in Java.

roleIsInvolved

public TaskQuery.FilterLink roleIsInvolved(String roleName,
 String applicationName)

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 corresponding IRole on query execution.

This method is equivalent to TaskQuery.IFilterableColumns.isInvolved(String, String)

Specified by:

roleIsInvolved in interface TaskQuery.IFilterableColumns

Parameters:

roleName - e.g. "TopManagementRole"

applicationName -

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 Java.

roleIsInvolved

public TaskQuery.FilterLink roleIsInvolved(IRole role)

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.

A role is not involved in a task if

• 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 interface TaskQuery.IFilterableColumns

Parameters:

role -

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 Java.

userIsInvolved

public TaskQuery.FilterLink userIsInvolved(IUser user)

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

A user is not involved in a task if

• 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 interface TaskQuery.IFilterableColumns

Parameters:

user -

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 Java.

userOrHisRolesAreInvolved

public TaskQuery.FilterLink userOrHisRolesAreInvolved(IUser user)

Description copied from interface: TaskQuery.IFilterableColumns

Filters all tasks the given user or any of his roles are involved in. See TaskQuery.IFilterableColumns.userIsInvolved(IUser) for a description of when a user is involved in a task and TaskQuery.IFilterableColumns.roleIsInvolved(IRole) for when a role is involved in a task.

Specified by:

userOrHisRolesAreInvolved in interface TaskQuery.IFilterableColumns

Parameters:

user -

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.userOrHisRolesAreInvolved(String, String)
• TaskQuery.IFilterableColumns.currentUserOrHisRolesAreInvolved()
• TaskQuery.IFilterableColumns.userIsInvolved(IUser)
• TaskQuery.IFilterableColumns.userIsInvolved(String, String)
• TaskQuery.IFilterableColumns.roleIsInvolved(IRole)
• TaskQuery.IFilterableColumns.roleIsInvolved(String, String)
• TaskQuery.IFilterableColumns.currentUserIsInvolved()
• CaseQuery.IFilterableColumns.userOrHisRolesAreInvolved(IUser)
• CaseQuery.IFilterableColumns.userOrHisRolesAreInvolved(String, String)
• CaseQuery.IFilterableColumns.currentUserOrHisRolesAreInvolved()

API:

This public API is available in Java.

canWorkOn

public TaskQuery.FilterLink canWorkOn(ISecurityMember member)

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 interface TaskQuery.IFilterableColumns

Parameters:

member -

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.currentUserCanWorkOn()
• TaskQuery.IFilterableColumns.canWorkOn(String, String)

API:

This public API is available in Java.

canWorkOn

public TaskQuery.FilterLink canWorkOn(String memberName,
 String applicationName)

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 method canWorkOn(ISecurityMember), this method evaluates the corresponding ISecurityMember 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 interface TaskQuery.IFilterableColumns

Parameters:

memberName - e.g. "#UserHans" or "TopManagementRole"

applicationName - e.g. "MyApplication"

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.currentUserCanWorkOn()
• TaskQuery.IFilterableColumns.canWorkOn(ISecurityMember)

API:

This public API is available in Java.

currentUserCanWorkOn

public TaskQuery.FilterLink 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 interface TaskQuery.IFilterableColumns

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.canWorkOn(ISecurityMember)
• TaskQuery.IFilterableColumns.canWorkOn(String, String)

API:

This public API is available in Java.

hasWorkedOn

public TaskQuery.FilterLink hasWorkedOn(ISecurityMember member)

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 interface TaskQuery.IFilterableColumns

Parameters:

member -

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.currentUserHasWorkedOn()
• TaskQuery.IFilterableColumns.hasWorkedOn(String, String)

API:

This public API is available in Java.

hasWorkedOn

public TaskQuery.FilterLink hasWorkedOn(String memberName,
 String applicationName)

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 method hasWorkedOn(ISecurityMember), this method evaluates the corresponding ISecurityMember 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 interface TaskQuery.IFilterableColumns

Parameters:

memberName - e.g. "#UserHans" or "TopManagementRole"

applicationName - e.g. "MyApplication"

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.currentUserHasWorkedOn()
• TaskQuery.IFilterableColumns.hasWorkedOn(ISecurityMember)

API:

This public API is available in Java.

currentUserHasWorkedOn

public TaskQuery.FilterLink 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 interface TaskQuery.IFilterableColumns

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.hasWorkedOn(ISecurityMember)
• TaskQuery.IFilterableColumns.hasWorkedOn(String, String)

API:

This public API is available in Java.

customField

public TaskQuery.ICustomFieldFilterQuery 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 interface TaskQuery.IFilterableColumns

Returns:

the query for further composition

API:

This public API is available in Java.

additionalProperty

@Deprecated
public TaskQuery.IStringColumnFilterQuery additionalProperty(String key)

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 interface TaskQuery.IFilterableColumns

Parameters:

key - the additional property key

Returns:

the query for further composition

API:

This public API is available in Java.

displayNameTemplate

@Deprecated(since="9.4",
            forRemoval=true)
public TaskQuery.IStringColumnFilterQuery displayNameTemplate()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: TaskQuery.IFilterableColumns

Does not add any filter because column DisplayNameTemplate was removed without any replacement.
Must be followed by a call to a condition method.

Specified by:

displayNameTemplate in interface TaskQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

displayDescriptionTemplate

@Deprecated(since="9.4",
            forRemoval=true)
public TaskQuery.IClobColumnFilterQuery displayDescriptionTemplate()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: TaskQuery.IFilterableColumns

Does not add any filter because column DisplayDescriptionTemplate was removed without any replacement.
Must be followed by a call to a condition method.

Specified by:

displayDescriptionTemplate in interface TaskQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

businessCaseId

public TaskQuery.IIntegerColumnFilterQuery 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 interface TaskQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.