Interface CaseQuery.IFilterableColumns
- All Known Subinterfaces:
CaseQuery.IFilterQuery
- All Known Implementing Classes:
CaseQuery.FilterQuery
- Enclosing class:
- CaseQuery
ICase
Example:
Corresponds to SQL:
CaseQuery.businessCases().where().customVarCharField1().isEqual("Hello World").and().customDecimalField2().isGreaterThan(15.3);
SELECT * FROM IWA_IWA_Case WHERE CustomVarCharField1 = 'Hello World' AND CustomDecimalField1 > 15.3
- API:
- This is a public API.
-
Method Summary
Modifier and TypeMethodDescriptionPrepares a where statement for the columnActivatorId
.
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.Deprecated, for removal: This API element is subject to removal in a future version.usebusinessCalendar()
insteadPrepares a where statement for the columnBusinessCaseId
.
Must be followed by a call to a condition method.Deprecated.use
insteadcustomField()
.numberField("BusinessCorrespondentId")
Deprecated.use
insteadcustomField()
.stringField("BusinessCreatorUser")
Deprecated.Deprecated.Deprecated.use
insteadcustomField()
.numberField("BusinessMainContactId")
Deprecated.use
insteadcustomField()
.stringField("BusinessMainContactName")
Deprecated.use
insteadcustomField()
.stringField("BusinessMainContactType")
Deprecated.Deprecated.use
insteadcustomField()
.stringField("BusinessObjectCode")
Deprecated.Deprecated.use
insteadcustomField()
.stringField("BusinessObjectFolderId")
Deprecated.use
insteadcustomField()
.stringField("BusinessObjectName")
Deprecated.use
insteadcustomField()
.stringField("BusinessPriority")
Prepares a where statement for the columnBusinessRuntime
.
Must be followed by a call to a condition method.Deprecated.Prepares a where statement for the columnBusinessState
.
Must be followed by a call to a condition method.canWorkOn
(ISecurityMember member) Filters all cases where the security member (user or role) can work on at least one task.canWorkOn
(IUserToken userToken) Filters all cases where the user token can work on at least one task.caseId()
Prepares a where statement for the columnCaseId
.
Must be followed by a call to a condition method.category()
Prepares a where statement for the columnCategory
.
Must be followed by a call to a condition method.Prepares a where statement for the columnCreatorId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnCreatorTaskId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnCreatorUserDisplayName
.
Must be followed by a call to a condition method.Deprecated, for removal: This API element is subject to removal in a future version.use
insteadcreatorId()
Prepares a where statement for the columnCreatorUserName
.
Must be followed by a call to a condition method.Filters all cases the user of the current session has started.Filters all cases the current session user is involved in.Filters all cases the current user is owner of.Deprecated.use
insteadcustomField()
.numberField("CustomDecimalField1")
Deprecated.use
insteadcustomField()
.numberField("CustomDecimalField2")
Deprecated.use
insteadcustomField()
.numberField("CustomDecimalField3")
Deprecated.use
insteadcustomField()
.numberField("CustomDecimalField4")
Deprecated.use
insteadcustomField()
.numberField("CustomDecimalField5")
Prepares a where statement for a custom field.
Must be followed by a call to a field value type.Deprecated.use
insteadcustomField()
.timestampField("CustomTimestampField1")
Deprecated.use
insteadcustomField()
.timestampField("CustomTimestampField2")
Deprecated.use
insteadcustomField()
.timestampField("CustomTimestampField3")
Deprecated.use
insteadcustomField()
.timestampField("CustomTimestampField4")
Deprecated.use
insteadcustomField()
.timestampField("CustomTimestampField5")
Deprecated.use
insteadcustomField()
.stringField("CustomVarCharField1")
Deprecated.use
insteadcustomField()
.stringField("CustomVarCharField2")
Deprecated.use
insteadcustomField()
.stringField("CustomVarCharField3")
Deprecated.use
insteadcustomField()
.stringField("CustomVarCharField4")
Deprecated.use
insteadcustomField()
.stringField("CustomVarCharField5")
Prepares a where statement for the columnDescription
.
Must be followed by a call to a condition method.Deprecated, for removal: This API element is subject to removal in a future version.the removedDisplayDescriptionTemplate
column was never used in production.Deprecated, for removal: This API element is subject to removal in a future version.the removedDisplayNameTemplate
column was never used in production.Prepares a where statement for the columnEndTimestamp
.
Must be followed by a call to a condition method.hasStarted
(ISecurityMember member) Filters all cases the given security member has started.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.Selects only cases that arebusiness cases
.
For performance reasons you should preferCaseQuery.businessCases()
to restrict your query to business cases.
Example:
Get all business casesisInvolved
(ISecurityMember member) Filters all cases the security member is involved in.
If the given security member is a user, this method is equivalent touserIsInvolved(IUser)
. If the given security member is a role, this method is equivalent toroleIsInvolved(IRole)
.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 methodisInvolved(ISecurityMember)
, this method evaluates the correspondingISecurityMember
on query execution.Selects only cases that are notbusiness cases
(e.g.isOwner
(ISecurityMember member) Filters all cases the security member is owner of.Filters all cases the member of the application is owner of.Prepares a where statement for the columnLanguageId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnModifiedTimestamp
.
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 columnOwnerDisplayName
.
Must be followed by a call to a condition method.ownerId()
Prepares a where statement for the columnOwnerId
.
Must be followed by a call to a condition method.Prepares a where statement for the columnOwnerName
.
Must be followed by a call to a condition method.Deprecated, for removal: This API element is subject to removal in a future version.use
insteadownerId()
Deprecated, for removal: This API element is subject to removal in a future version.use
insteadownerId()
priority()
Prepares a where statement for the columnPriority
.
Must be followed by a call to a condition method.Deprecated.use
insteadcustomField()
.stringField("ProcessCategoryCode")
Deprecated.use
insteadcustomField()
.stringField("ProcessCategoryName")
Deprecated.use
insteadcustomField()
.stringField("ProcessCode")
Prepares a where statement for the columnProcessModelId
.
Must be followed by a call to a condition method.Deprecated.use
insteadcustomField()
.stringField("ProcessName")
roleCanWorkOn
(IRole role) Filters all cases where the role can work on at least one task.roleIsInvolved
(IRole role) Filters all cases the role is involved in.roleIsInvolved
(String roleName, String applicationName) Filters all cases 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.stage()
Prepares a where statement for the columnStage
.
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.Deprecated.use
insteadcustomField()
.stringField("SubTypeCode")
Deprecated.use
insteadcustomField()
.stringField("SubTypeName")
Adds an expression to the where clause that selects those cases that have at least one matching task for the giventaskQuery
.Prepares a where statement for the columnTaskStartId
.
Must be followed by a call to a condition method.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 giventaskQuery
.typeCode()
Deprecated.use
insteadcustomField()
.stringField("TypeCode")
typeName()
Deprecated.use
insteadcustomField()
.stringField("TypeName")
userCanWorkOn
(IUser user) Filters all cases where the user can work on at least one task.userIsInvolved
(IUser user) Filters all cases the user is involved in.userIsInvolved
(String userName, String applicationName) Filters all cases where the user with given name in the given application is involved in.Prepares a where statement for the columnWorkingTime
.
Must be followed by a call to a condition method.
-
Method Details
-
isBusinessCase
CaseQuery.FilterLink isBusinessCase()Selects only cases that arebusiness cases
.
For performance reasons you should preferCaseQuery.businessCases()
to restrict your query to business cases.
Example:
Get all business casesimport ch.ivyteam.ivy.workflow.ICase; import ch.ivyteam.ivy.workflow.query.CaseQuery; CaseQuery query = CaseQuery.create().where().isBusinessCase(); List<ICase> businessCases = ivy.wf.getCaseQueryExecutor().getResults(query);
- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in Java.
-
isNotBusinessCase
CaseQuery.FilterLink isNotBusinessCase()Selects only cases that are notbusiness cases
(e.g. sub cases).
For performance reasons you should preferCaseQuery.subCases()
to restrict your query to sub cases (technical cases).
Example:
Get all sub casesimport ch.ivyteam.ivy.workflow.ICase; import ch.ivyteam.ivy.workflow.query.CaseQuery; CaseQuery query = CaseQuery.create().where().isNotBusinessCase(); List<ICase> subCases = ivy.wf.getCaseQueryExecutor().getResults(query);
- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in Java.
-
tasks
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 PARKEDimport 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);
- Parameters:
taskQuery
- task query with where clause to filter the tasks- Returns:
- the where query builder, for further building
- Throws:
IllegalArgumentException
- If the given taskQuery is null- API:
- This public API is available in Java.
-
triggeredByTasks
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);
- Parameters:
taskQuery
- task query with where clause to filter the tasks- Returns:
- the where query builder, for further building
- Throws:
IllegalArgumentException
- If the given taskQuery is null- API:
- This public API is available in Java.
-
isInvolved
Filters all cases the security member is involved in.
- If the given security member is a user, this method is equivalent to
userIsInvolved(IUser)
. - If the given security member is a role, this method is equivalent to
roleIsInvolved(IRole)
.
- Parameters:
member
-- Returns:
- the query for further composition
- Throws:
IllegalArgumentException
- If the given member is null- See Also:
- API:
- This public API is available in Java.
- If the given security member is a user, this method is equivalent to
-
isInvolved
Filters all cases where the security member with given member name (user or role) in the given application is involved in.
Compared to the methodisInvolved(ISecurityMember)
, this method evaluates the correspondingISecurityMember
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);
- 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:
- API:
- This public API is available in Java.
-
canWorkOn
Filters all cases where the security member (user or role) can work on at least one task.- Parameters:
member
- the security member (user or role)- Returns:
- the query for further composition
- Throws:
IllegalArgumentException
- If the given member is null- Since:
- 6.7
- See Also:
- API:
- This public API is available in Java.
-
canWorkOn
Filters all cases where the user token can work on at least one task.- Parameters:
userToken
- the user token- Returns:
- the query for further composition
- Throws:
IllegalArgumentException
- If the given member is null- Since:
- 6.7
- See Also:
- API:
- This public API is available in Java.
-
roleIsInvolved
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.
- 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);
- Parameters:
role
-- Returns:
- the query for further composition
- Throws:
IllegalArgumentException
- If the given role is null- See Also:
- API:
- This public API is available in Java.
-
roleIsInvolved
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 correspondingIRole
on query execution.This method is equivalent to
isInvolved(String, String)
- Parameters:
roleName
- e.g. "TopManagementRole"applicationName
-- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in Java.
-
userIsInvolved
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 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);
- Parameters:
user
-- Returns:
- the query for further composition
- Throws:
IllegalArgumentException
- If the given user is null- See Also:
- API:
- This public API is available in Java.
-
userIsInvolved
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 correspondingIUser
on query execution.This method is equivalent to
isInvolved("#" + userName, appName)
- Parameters:
userName
- e.g. "Joe"applicationName
-- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in Java.
-
currentUserIsInvolved
CaseQuery.FilterLink currentUserIsInvolved()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 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);
- Returns:
- the query for further composition
- Throws:
IllegalStateException
- If there is no current session available- See Also:
- API:
- This public API is available in Java.
-
userCanWorkOn
Filters all cases where the user can work on at least one task.- Parameters:
user
-- Returns:
- the query for further composition
- Throws:
IllegalArgumentException
- If the given member is null- Since:
- 6.7
- API:
- This public API is available in Java.
-
roleCanWorkOn
Filters all cases where the role can work on at least one task.- Parameters:
role
-- Returns:
- the query for further composition
- Throws:
IllegalArgumentException
- If the given member is null- Since:
- 6.7
- API:
- This public API is available in Java.
-
hasStarted
Filters all cases the given security member has started. A role is considered to have started a case if the given role is allowed to start a new case at the same process start the case was started on.
Example:
import ch.ivyteam.ivy.workflow.query.CaseQuery; import ch.ivyteam.ivy.workflow.ICase; import IUser; IUser user = ivy.wf.getSecurityContext().findUser("Somebody"); CaseQuery query = CaseQuery.businessCases().where().hasStarted(user); List<ICase> casesStartedByUser = ivy.wf.getCaseQueryExecutor().getResults(query);
- Parameters:
member
-- Returns:
- the query for further composition
- Throws:
IllegalArgumentException
- If the given member is null- See Also:
- API:
- This public API is available in Java.
-
hasStarted
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 correspondingISecurityMember
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);
- 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:
- API:
- This public API is available in Java.
-
currentUserHasStarted
CaseQuery.FilterLink currentUserHasStarted()Filters all cases the user of the current session has started.
Example:
import ch.ivyteam.ivy.workflow.query.CaseQuery; import ch.ivyteam.ivy.workflow.ICase; CaseQuery query = CaseQuery.businessCases().where().currentUserHasStarted(); List<ICase> casesStartedByUser = ivy.wf.getCaseQueryExecutor().getResults(query);
- Returns:
- the query for further composition
- Throws:
IllegalStateException
- If there is no current session available- See Also:
- API:
- This public API is available in Java.
-
isOwner
Filters all cases the security member is owner of.
Example:
import ch.ivyteam.ivy.workflow.query.CaseQuery; import ch.ivyteam.ivy.workflow.ICase; CaseQuery query = CaseQuery.businessCases().where().isOwner(ivy.session.getSessionUser()); List<ICase> casesCurrentUserIsOwnerOf = ivy.wf.getCaseQueryExecutor().getResults(query);
- Parameters:
member
- can not be null- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in Java.
-
currentUserIsOwner
CaseQuery.FilterLink currentUserIsOwner()Filters all cases the current user is owner of.
Example:
import ch.ivyteam.ivy.workflow.query.CaseQuery; import ch.ivyteam.ivy.workflow.ICase; CaseQuery query = CaseQuery.businessCases().where().currentUserIsOwner(); List<ICase> casesCurrentUserIsOwnerOf = ivy.wf.getCaseQueryExecutor().getResults(query);
- Returns:
- the query for further composition
- See Also:
- API:
- This public API is available in Java.
-
isOwner
Filters all cases the member of the application is owner of.
Example:
import ch.ivyteam.ivy.workflow.query.CaseQuery; import ch.ivyteam.ivy.workflow.ICase; CaseQuery query = CaseQuery.businessCases().where().isOwner("#Joe", "myApplication"); // note: to convert a user name to a member name a '#' is added as prefix List<ICase> casesCurrentUserIsOwnerOf = ivy.wf.getCaseQueryExecutor().getResults(query);
- 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:
- API:
- This public API is available in Java.
-
businessCalendarId
Deprecated, for removal: This API element is subject to removal in a future version.usebusinessCalendar()
insteadThis method is deprecated and does nothing! It will not add any filter to the query.
It exists only for backward compatibility reasons. In earlier version the method prepared a where statement for the column
BusinessCalendarId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customField
CaseQuery.ICustomFieldFilterQuery customField()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);
- Returns:
- the query for further composition
- API:
- This public API is available in Java.
-
additionalProperty
Deprecated.use
insteadcustomField()
.textField(key)
Prepares a where statement for an additional property value.
Must be followed by a call to a condition method.- Parameters:
key
- the additional property key- Returns:
- the query for further composition
- API:
- This public API is available in Java.
-
customVarCharField1
Deprecated.use
insteadcustomField()
.stringField("CustomVarCharField1")
Prepares a where statement for the custom field "CustomVarCharField1".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customVarCharField2
Deprecated.use
insteadcustomField()
.stringField("CustomVarCharField2")
Prepares a where statement for the custom field "CustomVarCharField2".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customVarCharField3
Deprecated.use
insteadcustomField()
.stringField("CustomVarCharField3")
Prepares a where statement for the custom field "CustomVarCharField3".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customVarCharField4
Deprecated.use
insteadcustomField()
.stringField("CustomVarCharField4")
Prepares a where statement for the custom field "CustomVarCharField4".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customVarCharField5
Deprecated.use
insteadcustomField()
.stringField("CustomVarCharField5")
Prepares a where statement for the custom field "CustomVarCharField5".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customDecimalField1
Deprecated.use
insteadcustomField()
.numberField("CustomDecimalField1")
Prepares a where statement for the custom field "CustomDecimalField1".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customDecimalField2
Deprecated.use
insteadcustomField()
.numberField("CustomDecimalField2")
Prepares a where statement for the custom field "CustomDecimalField2".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customDecimalField3
Deprecated.use
insteadcustomField()
.numberField("CustomDecimalField3")
Prepares a where statement for the custom field "CustomDecimalField3".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customDecimalField4
Deprecated.use
insteadcustomField()
.numberField("CustomDecimalField4")
Prepares a where statement for the custom field "CustomDecimalField4".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customDecimalField5
Deprecated.use
insteadcustomField()
.numberField("CustomDecimalField5")
Prepares a where statement for the custom field "CustomDecimalField5".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customTimestampField1
Deprecated.use
insteadcustomField()
.timestampField("CustomTimestampField1")
Prepares a where statement for the custom field "CustomTimestampField1".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customTimestampField2
Deprecated.use
insteadcustomField()
.timestampField("CustomTimestampField2")
Prepares a where statement for the custom field "CustomTimestampField2".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customTimestampField3
Deprecated.use
insteadcustomField()
.timestampField("CustomTimestampField3")
Prepares a where statement for the custom field "CustomTimestampField3".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customTimestampField4
Deprecated.use
insteadcustomField()
.timestampField("CustomTimestampField4")
Prepares a where statement for the custom field "CustomTimestampField4".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
customTimestampField5
Deprecated.use
insteadcustomField()
.timestampField("CustomTimestampField5")
Prepares a where statement for the custom field "CustomTimestampField5".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessMilestoneTimestamp
Deprecated.Prepares a where statement for the custom field "BusinessMilestoneTimestamp".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessCreatorUser
Deprecated.use
insteadcustomField()
.stringField("BusinessCreatorUser")
Prepares a where statement for the custom field "BusinessCreatorUser".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessMainContactId
Deprecated.use
insteadcustomField()
.numberField("BusinessMainContactId")
Prepares a where statement for the custom field "BusinessMainContactId".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessMainContactName
Deprecated.use
insteadcustomField()
.stringField("BusinessMainContactName")
Prepares a where statement for the custom field "BusinessMainContactName".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessObjectCode
Deprecated.use
insteadcustomField()
.stringField("BusinessObjectCode")
Prepares a where statement for the custom field "BusinessObjectCode".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessObjectName
Deprecated.use
insteadcustomField()
.stringField("BusinessObjectName")
Prepares a where statement for the custom field "BusinessObjectName".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessStartTimestamp
Deprecated.Prepares a where statement for the custom field "BusinessStartTimestamp".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessObjectFolderId
Deprecated.use
insteadcustomField()
.stringField("BusinessObjectFolderId")
Prepares a where statement for the custom field "BusinessObjectFolderId".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessObjectDocDbCode
Deprecated.Prepares a where statement for the custom field "BusinessObjectDocumentDbCode".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessMainContactDocDbCode
Deprecated.Prepares a where statement for the custom field "BusinessMainContactDocumentDbCode".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessMainContactFolderId
Deprecated.Prepares a where statement for the custom field "BusinessMainContactFolderId".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessPriority
Deprecated.use
insteadcustomField()
.stringField("BusinessPriority")
Prepares a where statement for the custom field "BusinessPriority".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessMainContactType
Deprecated.use
insteadcustomField()
.stringField("BusinessMainContactType")
Prepares a where statement for the custom field "BusinessMainContactType".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessCorrespondentId
Deprecated.use
insteadcustomField()
.numberField("BusinessCorrespondentId")
Prepares a where statement for the custom field "BusinessCorrespondentId".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
processCode
Deprecated.use
insteadcustomField()
.stringField("ProcessCode")
Prepares a where statement for the custom field "ProcessCode".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
processName
Deprecated.use
insteadcustomField()
.stringField("ProcessName")
Prepares a where statement for the custom field "ProcessName".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
processCategoryCode
Deprecated.use
insteadcustomField()
.stringField("ProcessCategoryCode")
Prepares a where statement for the custom field "ProcessCategoryCode".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
processCategoryName
Deprecated.use
insteadcustomField()
.stringField("ProcessCategoryName")
Prepares a where statement for the custom field "ProcessCategoryName".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
typeCode
Deprecated.use
insteadcustomField()
.stringField("TypeCode")
Prepares a where statement for the custom field "TypeCode".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
typeName
Deprecated.use
insteadcustomField()
.stringField("TypeName")
Prepares a where statement for the custom field "TypeName".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
subTypeCode
Deprecated.use
insteadcustomField()
.stringField("SubTypeCode")
Prepares a where statement for the custom field "SubTypeCode".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
subTypeName
Deprecated.use
insteadcustomField()
.stringField("SubTypeName")
Prepares a where statement for the custom field "SubTypeName".
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
creatorUserId
Deprecated, for removal: This API element is subject to removal in a future version.use
insteadcreatorId()
Prepares a where statement for the legacy field
CreatorUserId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
ownerRoleId
Deprecated, for removal: This API element is subject to removal in a future version.use
insteadownerId()
Prepares a where statement for the legacy field
OwnerRoleId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
ownerUserId
Deprecated, for removal: This API element is subject to removal in a future version.use
insteadownerId()
Prepares a where statement for the legacy field
OwnerUserId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
displayNameTemplate
Deprecated, for removal: This API element is subject to removal in a future version.the removedDisplayNameTemplate
column was never used in production.Does not add any filter because column
DisplayNameTemplate
was removed without any replacement.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
displayDescriptionTemplate
@Deprecated(since="9.4", forRemoval=true) CaseQuery.IClobColumnFilterQuery displayDescriptionTemplate()Deprecated, for removal: This API element is subject to removal in a future version.the removedDisplayDescriptionTemplate
column was never used in production.Does not add any filter because column
DisplayDescriptionTemplate
was removed without any replacement.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
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:CaseQuery subQuery = CaseQuery.businessCases().where() .customVarCharField1().equals("a").or() .customVarCharField2().equals("b") CaseQuery query = CaseQuery.businessCases().where() .not(subQuery)
SELECT * FROM IWA_IWA_Case WHERE NOT( customVarCharField1 = 'a' OR customVarCharField2 = 'b')
- 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
CaseQuery.IIntegerColumnFilterQuery caseId()Prepares a where statement for the column
CaseId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessCaseId
CaseQuery.IIntegerColumnFilterQuery businessCaseId()Prepares a where statement for the column
BusinessCaseId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
securitySystemId
CaseQuery.IIntegerColumnFilterQuery securitySystemId()Prepares a where statement for the column
SecuritySystemId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
applicationId
CaseQuery.IIntegerColumnFilterQuery applicationId()Prepares a where statement for the column
ApplicationId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
processModelId
CaseQuery.IIntegerColumnFilterQuery processModelId()Prepares a where statement for the column
ProcessModelId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
taskStartId
CaseQuery.IIntegerColumnFilterQuery taskStartId()Prepares a where statement for the column
TaskStartId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
activatorId
CaseQuery.IStringColumnFilterQuery activatorId()Prepares a where statement for the column
ActivatorId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
creatorId
CaseQuery.IStringColumnFilterQuery creatorId()Prepares a where statement for the column
CreatorId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
creatorUserName
CaseQuery.IStringColumnFilterQuery creatorUserName()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 referencedCreator
.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
creatorUserDisplayName
CaseQuery.IStringColumnFilterQuery creatorUserDisplayName()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 referencedCreator
.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
creatorTaskId
CaseQuery.IIntegerColumnFilterQuery creatorTaskId()Prepares a where statement for the column
CreatorTaskId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
name
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 referencedCaseLocalized
.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
description
CaseQuery.IClobColumnFilterQuery description()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 referencedCaseLocalized
.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
startTimestamp
CaseQuery.IDateColumnFilterQuery startTimestamp()Prepares a where statement for the column
StartTimestamp
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
endTimestamp
CaseQuery.IDateColumnFilterQuery endTimestamp()Prepares a where statement for the column
EndTimestamp
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
modifiedTimestamp
CaseQuery.IDateColumnFilterQuery modifiedTimestamp()Prepares a where statement for the column
ModifiedTimestamp
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessCalendar
CaseQuery.IStringColumnFilterQuery businessCalendar()Prepares a where statement for the column
BusinessCalendar
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
workingTime
CaseQuery.INumberColumnFilterQuery workingTime()Prepares a where statement for the column
WorkingTime
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessRuntime
CaseQuery.INumberColumnFilterQuery businessRuntime()Prepares a where statement for the column
BusinessRuntime
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
state
CaseQuery.ICaseStateFilterQuery state()Prepares a where statement for the column
State
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
businessState
CaseQuery.ICaseBusinessStateFilterQuery businessState()Prepares a where statement for the column
BusinessState
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
priority
CaseQuery.IWorkflowPriorityFilterQuery priority()Prepares a where statement for the column
Priority
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
stage
Prepares a where statement for the column
Stage
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
ownerId
CaseQuery.IStringColumnFilterQuery ownerId()Prepares a where statement for the column
OwnerId
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
ownerName
CaseQuery.IStringColumnFilterQuery ownerName()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 referencedOwner
.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
ownerDisplayName
CaseQuery.IStringColumnFilterQuery ownerDisplayName()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 referencedOwner
.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
category
CaseQuery.IStringColumnFilterQuery category()Prepares a where statement for the column
Category
.
Must be followed by a call to a condition method.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
languageId
CaseQuery.IIntegerColumnFilterQuery languageId()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 referencedCaseLocalized
.- Returns:
- query for further composition
- API:
- This public API is available in Java.
-
insteadcustomField()
.textField(key)