Package ch.ivyteam.ivy.workflow.query

Class CaseQuery.FilterQuery

java.lang.Object

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

ch.ivyteam.ivy.workflow.query.CaseQuery

ch.ivyteam.ivy.workflow.query.CaseQuery.FilterLink

ch.ivyteam.ivy.workflow.query.CaseQuery.FilterQuery

All Implemented Interfaces:

CaseQuery.IFilterableColumns, CaseQuery.IFilterLink, CaseQuery.IFilterQuery

Enclosing class:

CaseQuery

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

Provides filter functionality for ICase

Example:

CaseQuery.businessCases().where().customVarCharField1().isEqual("Hello World").and().customDecimalField2().isGreaterThan(15.3);

Corresponds to SQL:

SELECT * FROM IWA_IWA_Case WHERE CustomVarCharField1 = 'Hello World' AND CustomDecimalField1 > 15.3

API:

This is a public API.

Nested Class Summary

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

CaseQuery.AggregationQuery, CaseQuery.EnumValueOrderByColumnQuery<T extends ch.ivyteam.ivy.persistence.IPersistentEnumeration>, CaseQuery.FilterLink, CaseQuery.FilterQuery, CaseQuery.GroupByQuery, CaseQuery.IAggregationQuery, CaseQuery.IBoolFilterQuery, CaseQuery.ICaseBusinessStateFilterQuery, CaseQuery.ICaseStateFilterQuery, CaseQuery.IClobColumnFilterQuery, CaseQuery.IColumnFilterQuery, CaseQuery.ICustomFieldAggregationQuery, CaseQuery.ICustomFieldFilterQuery, CaseQuery.ICustomFieldGroupBy, CaseQuery.ICustomFieldOrderBy, CaseQuery.IDateColumnFilterQuery, CaseQuery.IFilterableColumns, CaseQuery.IFilterLink, CaseQuery.IFilterQuery, CaseQuery.IGroupByQueryColumns, CaseQuery.IIntegerColumnFilterQuery, CaseQuery.INumberColumnFilterQuery, CaseQuery.IOrderByQueryColumns, CaseQuery.IPatternColumnFilterQuery, CaseQuery.IStringColumnFilterQuery, CaseQuery.IUUIDColumnFilterQuery, CaseQuery.IWorkflowPriorityFilterQuery, CaseQuery.LongValueOrderByColumnQuery, CaseQuery.OrderByColumnQuery, CaseQuery.OrderByQuery, CaseQuery.StringValueOrderByColumnQuery

Method Summary

Modifier and Type	Method	Description
CaseQuery.IStringColumnFilterQuery	activatorId()	Prepares a where statement for the column ActivatorId. Must be followed by a call to a condition method.
CaseQuery.IStringColumnFilterQuery	additionalProperty(String key)	Deprecated.
CaseQuery.IIntegerColumnFilterQuery	applicationId()	Prepares a where statement for the column ApplicationId. Must be followed by a call to a condition method.
CaseQuery.IStringColumnFilterQuery	businessCalendar()	Prepares a where statement for the column BusinessCalendar. Must be followed by a call to a condition method.
CaseQuery.IIntegerColumnFilterQuery	businessCaseId()	Prepares a where statement for the column BusinessCaseId. Must be followed by a call to a condition method.
CaseQuery.INumberColumnFilterQuery	businessRuntime()	Prepares a where statement for the column BusinessRuntime. Must be followed by a call to a condition method.
CaseQuery.FilterLink	canWorkOn(ISecurityMember member)	Filters all cases where the security member (user or role) can work on at least one task.
CaseQuery.FilterLink	canWorkOn(IUserToken userToken)	Filters all cases where the user token can work on at least one task.
CaseQuery.IIntegerColumnFilterQuery	caseId()	Prepares a where statement for the column CaseId. Must be followed by a call to a condition method.
CaseQuery.IStringColumnFilterQuery	category()	Prepares a where statement for the column Category. Must be followed by a call to a condition method.
CaseQuery.IStringColumnFilterQuery	creatorId()	Prepares a where statement for the column CreatorId. Must be followed by a call to a condition method.
CaseQuery.IIntegerColumnFilterQuery	creatorTaskId()	Prepares a where statement for the column CreatorTaskId. Must be followed by a call to a condition method.
CaseQuery.IStringColumnFilterQuery	creatorUserDisplayName()	Prepares a where statement for the column CreatorUserDisplayName. Must be followed by a call to a condition method.
CaseQuery.IStringColumnFilterQuery	creatorUserName()	Prepares a where statement for the column CreatorUserName. Must be followed by a call to a condition method.
CaseQuery.FilterLink	currentUserIsInvolved()	Filters all cases the current session user is involved in.
CaseQuery.FilterLink	currentUserOrHisRolesAreInvolved()	Filters all cases the current user or any of his roles are involved in.
CaseQuery.ICustomFieldFilterQuery	customField()	Prepares a where statement for a custom field. Must be followed by a call to a field value type.
CaseQuery.IClobColumnFilterQuery	description()	Prepares a where statement for the column Description. Must be followed by a call to a condition method.
CaseQuery.IClobColumnFilterQuery	displayDescriptionTemplate()	Deprecated, for removal: This API element is subject to removal in a future version.
CaseQuery.IStringColumnFilterQuery	displayNameTemplate()	Deprecated, for removal: This API element is subject to removal in a future version.
CaseQuery.IDateColumnFilterQuery	endTimestamp()	Prepares a where statement for the column EndTimestamp. Must be followed by a call to a condition method.
CaseQuery.FilterLink	hasStarted(String memberName, String applicationName)	Filters all cases where the security member with given member name (user or role) in the given application has started.
CaseQuery.FilterLink	isInvolved(ISecurityMember member)	Filters all cases the security member is involved in. If the given security member is a user, this method is equivalent to CaseQuery.IFilterableColumns.userIsInvolved(IUser). If the given security member is a role, this method is equivalent to CaseQuery.IFilterableColumns.roleIsInvolved(IRole).
CaseQuery.FilterLink	isInvolved(String memberName, String applicationName)	Filters all cases 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.
CaseQuery.IIntegerColumnFilterQuery	languageId()	Prepares a where statement for the column LanguageId. Must be followed by a call to a condition method.
CaseQuery.IStringColumnFilterQuery	name()	Prepares a where statement for the column Name. Must be followed by a call to a condition method.
CaseQuery.FilterQuery	not(CaseQuery otherQuery)	Adds a condition, which negates a set of where conditions given by the otherQuery with a NOT expression. Only the where clause of the given otherQuery is considered.
CaseQuery.IStringColumnFilterQuery	ownerDisplayName()	Prepares a where statement for the column OwnerDisplayName. Must be followed by a call to a condition method.
CaseQuery.IStringColumnFilterQuery	ownerId()	Prepares a where statement for the column OwnerId. Must be followed by a call to a condition method.
CaseQuery.IStringColumnFilterQuery	ownerName()	Prepares a where statement for the column OwnerName. Must be followed by a call to a condition method.
CaseQuery.IWorkflowPriorityFilterQuery	priority()	Prepares a where statement for the column Priority. Must be followed by a call to a condition method.
CaseQuery.IIntegerColumnFilterQuery	processModelId()	Prepares a where statement for the column ProcessModelId. Must be followed by a call to a condition method.
CaseQuery.FilterLink	roleCanWorkOn(IRole role)	Filters all cases where the role can work on at least one task.
CaseQuery.FilterLink	roleIsInvolved(IRole role)	Filters all cases the role is involved in.
CaseQuery.FilterLink	roleIsInvolved(String roleName, String applicationName)	Filters all cases where the role with given name in the given application is involved in.
CaseQuery.IIntegerColumnFilterQuery	securitySystemId()	Prepares a where statement for the column SecuritySystemId. Must be followed by a call to a condition method.
CaseQuery.IStringColumnFilterQuery	stage()	Prepares a where statement for the column Stage. Must be followed by a call to a condition method.
CaseQuery.IDateColumnFilterQuery	startTimestamp()	Prepares a where statement for the column StartTimestamp. Must be followed by a call to a condition method.
CaseQuery.ICaseStateFilterQuery	state()	Prepares a where statement for the column State. Must be followed by a call to a condition method.
CaseQuery.FilterLink	tasks(TaskQuery taskQuery)	Adds an expression to the where clause that selects those cases that have at least one matching task for the given taskQuery.
CaseQuery.IIntegerColumnFilterQuery	taskStartId()	Prepares a where statement for the column TaskStartId. Must be followed by a call to a condition method.
CaseQuery.FilterLink	triggeredByTasks(TaskQuery taskQuery)	Adds an expression to the where clause that selects those cases that have been created with a Trigger process element by tasks which matches the given taskQuery.
CaseQuery.FilterLink	userCanWorkOn(IUser user)	Filters all cases where the user can work on at least one task.
CaseQuery.FilterLink	userIsInvolved(IUser user)	Filters all cases the user is involved in.
CaseQuery.FilterLink	userIsInvolved(String userName, String applicationName)	Filters all cases where the user with given name in the given application is involved in.
CaseQuery.FilterLink	userOrHisRolesAreInvolved(IUser user)	Filters all cases the user or any of his roles are involved in.
CaseQuery.FilterLink	userOrHisRolesAreInvolved(String userName, String applicationName)	Filters all cases the user or any of his roles are involved in.
CaseQuery.INumberColumnFilterQuery	workingTime()	Prepares a where statement for the column WorkingTime. Must be followed by a call to a condition method.

Methods inherited from class ch.ivyteam.ivy.workflow.query.CaseQuery.FilterLink

and, and, andOverall, andOverall, or, or

Methods inherited from class ch.ivyteam.ivy.workflow.query.CaseQuery

aggregate, asJson, businessCases, create, executor, fromJson, groupBy, orderBy, subCases, toType, where

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

equals, hashCode

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

and, and, andOverall, andOverall, or, or

Method Details

tasks

public CaseQuery.FilterLink tasks(TaskQuery taskQuery)

Description copied from interface: CaseQuery.IFilterableColumns

Adds an expression to the where clause that selects those cases that have at least one matching task for the given taskQuery.

This method considers only the where clause of the given taskQuery. All other parts are ignored.

Example:
Get all cases that have tasks in state PARKED

 import ch.ivyteam.ivy.workflow.ICase;
 import ch.ivyteam.ivy.workflow.TaskState;
 import ch.ivyteam.ivy.workflow.query.TaskQuery;
 import ch.ivyteam.ivy.workflow.query.CaseQuery;

 CaseQuery query = CaseQuery.businessCases().where().tasks(TaskQuery.create().where().state().isEqual(TaskState.PARKED));
 List<ICase> casesWithParkedTasks = ivy.wf.getCaseQueryExecutor().getResults(query);
 

Specified by:

tasks in interface CaseQuery.IFilterableColumns

Parameters:

taskQuery - task query with where clause to filter the tasks

Returns:

the where query builder, for further building

API:

This public API is available in Java.

triggeredByTasks

public CaseQuery.FilterLink triggeredByTasks(TaskQuery taskQuery)

Description copied from interface: CaseQuery.IFilterableColumns

Adds an expression to the where clause that selects those cases that have been created with a Trigger process element by tasks which matches the given taskQuery.

Cases can be triggered by tasks by using the Trigger process element.

This method considers only the where clause of the given taskQuery. All other parts are ignored.

Example:
Get all cases that were created by tasks with kind code "Order"

 import ch.ivyteam.ivy.workflow.ICase;
 import ch.ivyteam.ivy.workflow.TaskState;
 import ch.ivyteam.ivy.workflow.query.TaskQuery;
 import ch.ivyteam.ivy.workflow.query.CaseQuery;

 CaseQuery query = CaseQuery.businessCases().where().triggeredByTasks(TaskQuery.create().where().kindCode().isEqual("Order"));
 List<ICase> casesCreatedByTasksOfProcessOrder = ivy.wf.getCaseQueryExecutor().getResults(query);
 

Specified by:

triggeredByTasks in interface CaseQuery.IFilterableColumns

Parameters:

taskQuery - task query with where clause to filter the tasks

Returns:

the where query builder, for further building

API:

This public API is available in Java.

isInvolved

public CaseQuery.FilterLink isInvolved(ISecurityMember member)

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases the security member is involved in.

• If the given security member is a user, this method is equivalent to CaseQuery.IFilterableColumns.userIsInvolved(IUser).
• If the given security member is a role, this method is equivalent to CaseQuery.IFilterableColumns.roleIsInvolved(IRole).

Specified by:

isInvolved in interface CaseQuery.IFilterableColumns

Parameters:

member -

Returns:

the query for further composition

See Also:

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

API:

This public API is available in Java.

canWorkOn

public CaseQuery.FilterLink canWorkOn(ISecurityMember member)

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases where the security member (user or role) can work on at least one task.

Specified by:

canWorkOn in interface CaseQuery.IFilterableColumns

Parameters:

member - the security member (user or role)

Returns:

the query for further composition

See Also:

• CaseQuery.IFilterableColumns.canWorkOn(IUserToken)

API:

This public API is available in Java.

canWorkOn

public CaseQuery.FilterLink canWorkOn(IUserToken userToken)

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases where the user token can work on at least one task.

Specified by:

canWorkOn in interface CaseQuery.IFilterableColumns

Parameters:

userToken - the user token

Returns:

the query for further composition

See Also:

• CaseQuery.IFilterableColumns.canWorkOn(ISecurityMember)

API:

This public API is available in Java.

isInvolved

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

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases 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 'Joe' is involved in:

 import ch.ivyteam.ivy.workflow.ICase;
 import ch.ivyteam.ivy.workflow.query.CaseQuery;

 CaseQuery query = CaseQuery.businessCases()
   .where().isInvolved("#Joe", "MyApp") // note: to convert a user name to a member name a '#' is added as prefix
      .or().isInvolved(ivy.session.getSessionUser().getMemberName(), "MyApp");

 List<ICase> cases = ivy.wf.getCaseQueryExecutor().getResults(query);
 

Specified by:

isInvolved in interface CaseQuery.IFilterableColumns

Parameters:

memberName - e.g. a role "TopManagementRole", e.g. a user must be prefixed with # "#Joe"

applicationName - e.g. "MyApplication"

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.userIsInvolved(IUser)
• TaskQuery.IFilterableColumns.userIsInvolved(String, String)
• CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
• CaseQuery.IFilterableColumns.currentUserIsInvolved()
• CaseQuery.IFilterableColumns.userIsInvolved(IUser)
• CaseQuery.IFilterableColumns.userIsInvolved(String, String)
• CaseQuery.IFilterableColumns.roleIsInvolved(IRole)
• CaseQuery.IFilterableColumns.roleIsInvolved(String, String)

API:

This public API is available in Java.

currentUserIsInvolved

public CaseQuery.FilterLink currentUserIsInvolved()

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases the current session user is involved in. The current session user is involved in a case if

• the current session user is the creator of the case

• the current session user is involved in at least one task of the case
  The current session user is involved in a task if

  • the current session user could work on the task
  • the current session user is working at the task right now
  • the current session user has completed the task
  The current session user is not involved in a task if
  • the current session 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 current session user can work on the task but it is delayed

Example:

 import ch.ivyteam.ivy.workflow.query.CaseQuery;
 import ch.ivyteam.ivy.workflow.ICase;

 CaseQuery query = CaseQuery.businessCases().where().currentUserIsInvolved();
 List<ICase> sessionInvolvedCases = ivy.wf.getCaseQueryExecutor().getResults(query);

Specified by:

currentUserIsInvolved in interface CaseQuery.IFilterableColumns

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.userIsInvolved(IUser)
• TaskQuery.IFilterableColumns.userIsInvolved(String, String)
• CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
• CaseQuery.IFilterableColumns.isInvolved(String, String)
• CaseQuery.IFilterableColumns.userIsInvolved(IUser)
• CaseQuery.IFilterableColumns.userIsInvolved(String, String)
• CaseQuery.IFilterableColumns.roleIsInvolved(IRole)
• CaseQuery.IFilterableColumns.roleIsInvolved(String, String)

API:

This public API is available in Java.

currentUserOrHisRolesAreInvolved

public CaseQuery.FilterLink currentUserOrHisRolesAreInvolved()

Description copied from interface: CaseQuery.IFilterableColumns

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

Example:

 import ch.ivyteam.ivy.workflow.query.CaseQuery;
 import ch.ivyteam.ivy.workflow.ICase;
 import IUser;

 IUser user = ivy.session.getSessionUser();
 CaseQuery query = CaseQuery.businessCases().where().currentUserOrHisRolesAreInvolved();
 List<ICase> userInvolvedCases = ivy.wf.getCaseQueryExecutor().getResults(query);

Specified by:

currentUserOrHisRolesAreInvolved in interface CaseQuery.IFilterableColumns

Returns:

the query for further composition

See Also:

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

API:

This public API is available in Java.

roleIsInvolved

public CaseQuery.FilterLink roleIsInvolved(IRole role)

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases the role is involved in. A role is involved in a case if the role is involved in at least one task of the case.

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.CaseQuery;
 import ch.ivyteam.ivy.workflow.ITask;
 import IRole;

 IRole role = ivy.session.getSecurityContext().findRole("Admin");
 CaseQuery query = CaseQuery.businessCases().where().roleIsInvolved(role);
 List<ICase> userInvolvedCases = ivy.wf.getCaseQueryExecutor().getResults(query);

Specified by:

roleIsInvolved in interface CaseQuery.IFilterableColumns

Parameters:

role -

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.userIsInvolved(IUser)
• TaskQuery.IFilterableColumns.userIsInvolved(String, String)
• CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
• CaseQuery.IFilterableColumns.isInvolved(String, String)
• CaseQuery.IFilterableColumns.currentUserIsInvolved()
• CaseQuery.IFilterableColumns.userIsInvolved(IUser)
• CaseQuery.IFilterableColumns.userIsInvolved(String, String)
• CaseQuery.IFilterableColumns.roleIsInvolved(String, String)

API:

This public API is available in Java.

roleIsInvolved

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

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases 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 CaseQuery.IFilterableColumns.isInvolved(String, String)

Specified by:

roleIsInvolved in interface CaseQuery.IFilterableColumns

Parameters:

roleName - e.g. "TopManagementRole"

applicationName -

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.userIsInvolved(IUser)
• TaskQuery.IFilterableColumns.userIsInvolved(String, String)
• CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
• CaseQuery.IFilterableColumns.isInvolved(String, String)
• CaseQuery.IFilterableColumns.currentUserIsInvolved()
• CaseQuery.IFilterableColumns.userIsInvolved(IUser)
• CaseQuery.IFilterableColumns.userIsInvolved(String, String)
• CaseQuery.IFilterableColumns.roleIsInvolved(IRole)

API:

This public API is available in Java.

userIsInvolved

public CaseQuery.FilterLink userIsInvolved(IUser user)

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases the user is involved in. A user is involved in a case if

• the user is the creator of the case

• the user is involved in at least one task of the case
  The 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 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.CaseQuery;
 import ch.ivyteam.ivy.workflow.ICase;
 import IUser;

 IUser user = ivy.session.getSessionUser();
 CaseQuery query = CaseQuery.businessCases().where().userIsInvolved(user);
 List<ICase> userInvolvedCases = ivy.wf.getCaseQueryExecutor().getResults(query);

Specified by:

userIsInvolved in interface CaseQuery.IFilterableColumns

Parameters:

user -

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.userIsInvolved(IUser)
• TaskQuery.IFilterableColumns.userIsInvolved(String, String)
• CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
• CaseQuery.IFilterableColumns.isInvolved(String, String)
• CaseQuery.IFilterableColumns.currentUserIsInvolved()
• CaseQuery.IFilterableColumns.userIsInvolved(String, String)
• CaseQuery.IFilterableColumns.roleIsInvolved(IRole)
• CaseQuery.IFilterableColumns.roleIsInvolved(String, String)

API:

This public API is available in Java.

userIsInvolved

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

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases 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, appName)

Specified by:

userIsInvolved in interface CaseQuery.IFilterableColumns

Parameters:

userName - e.g. "Joe"

applicationName -

Returns:

the query for further composition

See Also:

• TaskQuery.IFilterableColumns.userIsInvolved(IUser)
• TaskQuery.IFilterableColumns.userIsInvolved(String, String)
• CaseQuery.IFilterableColumns.isInvolved(ISecurityMember)
• CaseQuery.IFilterableColumns.isInvolved(String, String)
• CaseQuery.IFilterableColumns.currentUserIsInvolved()
• CaseQuery.IFilterableColumns.userIsInvolved(IUser)
• CaseQuery.IFilterableColumns.roleIsInvolved(IRole)
• CaseQuery.IFilterableColumns.roleIsInvolved(String, String)

API:

This public API is available in Java.

userOrHisRolesAreInvolved

public CaseQuery.FilterLink userOrHisRolesAreInvolved(IUser user)

Description copied from interface: CaseQuery.IFilterableColumns

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

Example:

 import ch.ivyteam.ivy.workflow.query.CaseQuery;
 import ch.ivyteam.ivy.workflow.ICase;
 import IUser;

 IUser user = ivy.session.getSessionUser();
 CaseQuery query = CaseQuery.businessCases().where().userOrHisRolesAreInvolved(user);
 List<ICase> userInvolvedCases = ivy.wf.getCaseQueryExecutor().getResults(query);

Specified by:

userOrHisRolesAreInvolved in interface CaseQuery.IFilterableColumns

Parameters:

user -

Returns:

the query for further composition

See Also:

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

API:

This public API is available in Java.

userOrHisRolesAreInvolved

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

Description copied from interface: CaseQuery.IFilterableColumns

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

Example:

 import ch.ivyteam.ivy.workflow.query.CaseQuery;
 import ch.ivyteam.ivy.workflow.ICase;
 import IUser;

 CaseQuery query = CaseQuery.businessCases().where().userOrHisRolesAreInvolved("Joe", "CRM");
 List<ICase> userInvolvedCases = ivy.wf.getCaseQueryExecutor().getResults(query);

Specified by:

userOrHisRolesAreInvolved in interface CaseQuery.IFilterableColumns

Parameters:

userName - e.g. "Joe"

applicationName -

Returns:

the query for further composition

See Also:

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

API:

This public API is available in Java.

userCanWorkOn

public CaseQuery.FilterLink userCanWorkOn(IUser user)

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases where the user can work on at least one task.

Specified by:

userCanWorkOn in interface CaseQuery.IFilterableColumns

Parameters:

user -

Returns:

the query for further composition

API:

This public API is available in Java.

roleCanWorkOn

public CaseQuery.FilterLink roleCanWorkOn(IRole role)

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases where the role can work on at least one task.

Specified by:

roleCanWorkOn in interface CaseQuery.IFilterableColumns

Parameters:

role -

Returns:

the query for further composition

API:

This public API is available in Java.

hasStarted

public CaseQuery.FilterLink hasStarted(String memberName,
 String applicationName)

Description copied from interface: CaseQuery.IFilterableColumns

Filters all cases where the security member with given member name (user or role) in the given application has started.

Compared to the method hasStarted(ISecurityMember), this method evaluates the corresponding ISecurityMember on query execution.

Get all tasks where the current user or the user 'Joe' has started:

 import ch.ivyteam.ivy.workflow.ICase;
 import ch.ivyteam.ivy.workflow.query.CaseQuery;

 CaseQuery query = CaseQuery.businessCases()
   .where().hasStarted("#Joe", "MyApp") // note: to convert a user name to a member name a '#' is added as prefix
      .or().hasStarted(ivy.session.getSessionUser().getMemberName(), "MyApp");

 List<ICase> cases = ivy.wf.getCaseQueryExecutor().getResults(query);
 

Specified by:

hasStarted in interface CaseQuery.IFilterableColumns

Parameters:

memberName - e.g. a role "TopManagementRole", e.g. a user must be prefixed with # "#Joe"

applicationName - e.g. "MyApplication"

Returns:

the query for further composition

See Also:

• CaseQuery.IFilterableColumns.currentUserHasStarted()
• CaseQuery.IFilterableColumns.hasStarted(ISecurityMember)

API:

This public API is available in Java.

customField

public CaseQuery.ICustomFieldFilterQuery customField()

Description copied from interface: CaseQuery.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.ICase;
 import ch.ivyteam.ivy.workflow.query.CaseQuery;

 CaseQuery query = CaseQuery.businessCases().where().customField().stringField("myCustomField").isEqualTo("valueToFind")";
 List<ICase> casesWithMatchingField = ivy.wf.getCaseQueryExecutor().getResults(query);

Specified by:

customField in interface CaseQuery.IFilterableColumns

Returns:

the query for further composition

API:

This public API is available in Java.

additionalProperty

@Deprecated
public CaseQuery.IStringColumnFilterQuery additionalProperty(String key)

Deprecated.

Description copied from interface: CaseQuery.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 CaseQuery.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 CaseQuery.IStringColumnFilterQuery displayNameTemplate()

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

Description copied from interface: CaseQuery.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 CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

displayDescriptionTemplate

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

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

Description copied from interface: CaseQuery.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 CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

not

public CaseQuery.FilterQuery not(CaseQuery otherQuery)

Adds a condition, which negates a set of where conditions given by the otherQuery with a NOT expression.
Only the where clause of the given otherQuery is considered. All other parts are ignored.

SQL part: NOT([otherSqlExpression])

Example:

CaseQuery subQuery = CaseQuery.businessCases().where()
      .customVarCharField1().equals("a").or()
      .customVarCharField2().equals("b")
CaseQuery query = CaseQuery.businessCases().where()
      .not(subQuery)

Corresponds to SQL:

SELECT * FROM IWA_IWA_Case
  WHERE NOT(
    customVarCharField1 = 'a'
    OR customVarCharField2 = 'b')

Specified by:

not in interface CaseQuery.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 Java.

caseId

public CaseQuery.IIntegerColumnFilterQuery caseId()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column CaseId.
Must be followed by a call to a condition method.

Specified by:

caseId in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

businessCaseId

public CaseQuery.IIntegerColumnFilterQuery businessCaseId()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column BusinessCaseId.
Must be followed by a call to a condition method.

Specified by:

businessCaseId in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

securitySystemId

public CaseQuery.IIntegerColumnFilterQuery securitySystemId()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column SecuritySystemId.
Must be followed by a call to a condition method.

Specified by:

securitySystemId in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

applicationId

public CaseQuery.IIntegerColumnFilterQuery applicationId()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column ApplicationId.
Must be followed by a call to a condition method.

Specified by:

applicationId in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

processModelId

public CaseQuery.IIntegerColumnFilterQuery processModelId()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column ProcessModelId.
Must be followed by a call to a condition method.

Specified by:

processModelId in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

taskStartId

public CaseQuery.IIntegerColumnFilterQuery taskStartId()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column TaskStartId.
Must be followed by a call to a condition method.

Specified by:

taskStartId in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

activatorId

public CaseQuery.IStringColumnFilterQuery activatorId()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column ActivatorId.
Must be followed by a call to a condition method.

Specified by:

activatorId in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

creatorId

public CaseQuery.IStringColumnFilterQuery creatorId()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column CreatorId.
Must be followed by a call to a condition method.

Specified by:

creatorId in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

creatorUserName

public CaseQuery.IStringColumnFilterQuery creatorUserName()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column CreatorUserName.
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 referenced Creator.

Specified by:

creatorUserName in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

creatorUserDisplayName

public CaseQuery.IStringColumnFilterQuery creatorUserDisplayName()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column CreatorUserDisplayName.
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 referenced Creator.

Specified by:

creatorUserDisplayName in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

creatorTaskId

public CaseQuery.IIntegerColumnFilterQuery creatorTaskId()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column CreatorTaskId.
Must be followed by a call to a condition method.

Specified by:

creatorTaskId in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

name

public CaseQuery.IStringColumnFilterQuery name()

Description copied from interface: CaseQuery.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 referenced CaseLocalized.

Specified by:

name in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

description

public CaseQuery.IClobColumnFilterQuery description()

Description copied from interface: CaseQuery.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 referenced CaseLocalized.

Specified by:

description in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

startTimestamp

public CaseQuery.IDateColumnFilterQuery startTimestamp()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column StartTimestamp.
Must be followed by a call to a condition method.

Specified by:

startTimestamp in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

endTimestamp

public CaseQuery.IDateColumnFilterQuery endTimestamp()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column EndTimestamp.
Must be followed by a call to a condition method.

Specified by:

endTimestamp in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

businessCalendar

public CaseQuery.IStringColumnFilterQuery businessCalendar()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column BusinessCalendar.
Must be followed by a call to a condition method.

Specified by:

businessCalendar in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

workingTime

public CaseQuery.INumberColumnFilterQuery workingTime()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column WorkingTime.
Must be followed by a call to a condition method.

Specified by:

workingTime in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

businessRuntime

public CaseQuery.INumberColumnFilterQuery businessRuntime()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column BusinessRuntime.
Must be followed by a call to a condition method.

Specified by:

businessRuntime in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

state

public CaseQuery.ICaseStateFilterQuery state()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column State.
Must be followed by a call to a condition method.

Specified by:

state in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

priority

public CaseQuery.IWorkflowPriorityFilterQuery priority()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column Priority.
Must be followed by a call to a condition method.

Specified by:

priority in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

stage

public CaseQuery.IStringColumnFilterQuery stage()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column Stage.
Must be followed by a call to a condition method.

Specified by:

stage in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

ownerId

public CaseQuery.IStringColumnFilterQuery ownerId()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column OwnerId.
Must be followed by a call to a condition method.

Specified by:

ownerId in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

ownerName

public CaseQuery.IStringColumnFilterQuery ownerName()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column OwnerName.
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 referenced Owner.

Specified by:

ownerName in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

ownerDisplayName

public CaseQuery.IStringColumnFilterQuery ownerDisplayName()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column OwnerDisplayName.
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 referenced Owner.

Specified by:

ownerDisplayName in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

category

public CaseQuery.IStringColumnFilterQuery category()

Description copied from interface: CaseQuery.IFilterableColumns

Prepares a where statement for the column Category.
Must be followed by a call to a condition method.

Specified by:

category in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.

languageId

public CaseQuery.IIntegerColumnFilterQuery languageId()

Description copied from interface: CaseQuery.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 referenced CaseLocalized.

Specified by:

languageId in interface CaseQuery.IFilterableColumns

Returns:

query for further composition

API:

This public API is available in Java.