ProcessInstanceQueryDto (Camunda Platform Javadocs 7.15.19-ee)

java.lang.Object
- org.openapitools.client.model.ProcessInstanceQueryDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-09-29T11:12:16.359+02:00[Europe/Berlin]")
public class ProcessInstanceQueryDto
extends Object

A process instance query which defines a group of process instances

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACTIVE`
`static String`	`SERIALIZED_NAME_ACTIVITY_ID_IN`
`static String`	`SERIALIZED_NAME_BUSINESS_KEY`
`static String`	`SERIALIZED_NAME_BUSINESS_KEY_LIKE`
`static String`	`SERIALIZED_NAME_CASE_INSTANCE_ID`
`static String`	`SERIALIZED_NAME_DEPLOYMENT_ID`
`static String`	`SERIALIZED_NAME_INCIDENT_ID`
`static String`	`SERIALIZED_NAME_INCIDENT_MESSAGE`
`static String`	`SERIALIZED_NAME_INCIDENT_MESSAGE_LIKE`
`static String`	`SERIALIZED_NAME_INCIDENT_TYPE`
`static String`	`SERIALIZED_NAME_LEAF_PROCESS_INSTANCES`
`static String`	`SERIALIZED_NAME_OR_QUERIES`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_ID`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_KEY`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_KEY_IN`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_KEY_NOT_IN`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_WITHOUT_TENANT_ID`
`static String`	`SERIALIZED_NAME_PROCESS_INSTANCE_IDS`
`static String`	`SERIALIZED_NAME_ROOT_PROCESS_INSTANCES`
`static String`	`SERIALIZED_NAME_SORTING`
`static String`	`SERIALIZED_NAME_SUB_CASE_INSTANCE`
`static String`	`SERIALIZED_NAME_SUB_PROCESS_INSTANCE`
`static String`	`SERIALIZED_NAME_SUPER_CASE_INSTANCE`
`static String`	`SERIALIZED_NAME_SUPER_PROCESS_INSTANCE`
`static String`	`SERIALIZED_NAME_SUSPENDED`
`static String`	`SERIALIZED_NAME_TENANT_ID_IN`
`static String`	`SERIALIZED_NAME_VARIABLE_NAMES_IGNORE_CASE`
`static String`	`SERIALIZED_NAME_VARIABLE_VALUES_IGNORE_CASE`
`static String`	`SERIALIZED_NAME_VARIABLES`
`static String`	`SERIALIZED_NAME_WITH_INCIDENT`
`static String`	`SERIALIZED_NAME_WITHOUT_TENANT_ID`

Constructor Summary

Constructors
Constructor and Description

ProcessInstanceQueryDto()

Constructors
Constructor and Description
`ProcessInstanceQueryDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessInstanceQueryDto`	`active(Boolean active)`
`ProcessInstanceQueryDto`	`activityIdIn(List<String> activityIdIn)`
`ProcessInstanceQueryDto`	`addActivityIdInItem(String activityIdInItem)`
`ProcessInstanceQueryDto`	`addOrQueriesItem(ProcessInstanceQueryDto orQueriesItem)`
`ProcessInstanceQueryDto`	`addProcessDefinitionKeyInItem(String processDefinitionKeyInItem)`
`ProcessInstanceQueryDto`	`addProcessDefinitionKeyNotInItem(String processDefinitionKeyNotInItem)`
`ProcessInstanceQueryDto`	`addProcessInstanceIdsItem(String processInstanceIdsItem)`
`ProcessInstanceQueryDto`	`addSortingItem(ProcessInstanceQueryDtoSorting sortingItem)`
`ProcessInstanceQueryDto`	`addTenantIdInItem(String tenantIdInItem)`
`ProcessInstanceQueryDto`	`addVariablesItem(VariableQueryParameterDto variablesItem)`
`ProcessInstanceQueryDto`	`businessKey(String businessKey)`
`ProcessInstanceQueryDto`	`businessKeyLike(String businessKeyLike)`
`ProcessInstanceQueryDto`	`caseInstanceId(String caseInstanceId)`
`ProcessInstanceQueryDto`	`deploymentId(String deploymentId)`
`boolean`	`equals(Object o)`
`Boolean`	`getActive()` Only include active process instances.
`List<String>`	`getActivityIdIn()` Filter by a list of activity ids.
`String`	`getBusinessKey()` Filter by process instance business key.
`String`	`getBusinessKeyLike()` Filter by process instance business key that the parameter is a substring of.
`String`	`getCaseInstanceId()` Filter by case instance id.
`String`	`getDeploymentId()` Filter by the deployment the id belongs to.
`String`	`getIncidentId()` Filter by the incident id.
`String`	`getIncidentMessage()` Filter by the incident message.
`String`	`getIncidentMessageLike()` Filter by the incident message that the parameter is a substring of.
`String`	`getIncidentType()` Filter by the incident type.
`Boolean`	`getLeafProcessInstances()` Restrict the query to all process instances that are leaf instances.
`List<ProcessInstanceQueryDto>`	`getOrQueries()` A JSON array of nested process instance queries with OR semantics.
`String`	`getProcessDefinitionId()` Filter by the process definition the instances run on.
`String`	`getProcessDefinitionKey()` Filter by the key of the process definition the instances run on.
`List<String>`	`getProcessDefinitionKeyIn()` Filter by a list of process definition keys.
`List<String>`	`getProcessDefinitionKeyNotIn()` Exclude instances by a list of process definition keys.
`Boolean`	`getProcessDefinitionWithoutTenantId()` Only include process instances which process definition has no tenant id.
`List<String>`	`getProcessInstanceIds()` Filter by a list of process instance ids.
`Boolean`	`getRootProcessInstances()` Restrict the query to all process instances that are top level process instances.
`List<ProcessInstanceQueryDtoSorting>`	`getSorting()` Apply sorting of the result
`String`	`getSubCaseInstance()` Restrict query to all process instances that have the given case instance as a sub case instance.
`String`	`getSubProcessInstance()` Restrict query to all process instances that have the given process instance as a sub process instance.
`String`	`getSuperCaseInstance()` Restrict query to all process instances that are sub process instances of the given case instance.
`String`	`getSuperProcessInstance()` Restrict query to all process instances that are sub process instances of the given process instance.
`Boolean`	`getSuspended()` Only include suspended process instances.
`List<String>`	`getTenantIdIn()` Filter by a list of tenant ids.
`Boolean`	`getVariableNamesIgnoreCase()` Match all variable names in this query case-insensitively.
`List<VariableQueryParameterDto>`	`getVariables()` A JSON array to only include process instances that have variables with certain values.
`Boolean`	`getVariableValuesIgnoreCase()` Match all variable values in this query case-insensitively.
`Boolean`	`getWithIncident()` Filter by presence of incidents.
`Boolean`	`getWithoutTenantId()` Only include process instances which belong to no tenant.
`int`	`hashCode()`
`ProcessInstanceQueryDto`	`incidentId(String incidentId)`
`ProcessInstanceQueryDto`	`incidentMessage(String incidentMessage)`
`ProcessInstanceQueryDto`	`incidentMessageLike(String incidentMessageLike)`
`ProcessInstanceQueryDto`	`incidentType(String incidentType)`
`ProcessInstanceQueryDto`	`leafProcessInstances(Boolean leafProcessInstances)`
`ProcessInstanceQueryDto`	`orQueries(List<ProcessInstanceQueryDto> orQueries)`
`ProcessInstanceQueryDto`	`processDefinitionId(String processDefinitionId)`
`ProcessInstanceQueryDto`	`processDefinitionKey(String processDefinitionKey)`
`ProcessInstanceQueryDto`	`processDefinitionKeyIn(List<String> processDefinitionKeyIn)`
`ProcessInstanceQueryDto`	`processDefinitionKeyNotIn(List<String> processDefinitionKeyNotIn)`
`ProcessInstanceQueryDto`	`processDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)`
`ProcessInstanceQueryDto`	`processInstanceIds(List<String> processInstanceIds)`
`ProcessInstanceQueryDto`	`rootProcessInstances(Boolean rootProcessInstances)`
`void`	`setActive(Boolean active)`
`void`	`setActivityIdIn(List<String> activityIdIn)`
`void`	`setBusinessKey(String businessKey)`
`void`	`setBusinessKeyLike(String businessKeyLike)`
`void`	`setCaseInstanceId(String caseInstanceId)`
`void`	`setDeploymentId(String deploymentId)`
`void`	`setIncidentId(String incidentId)`
`void`	`setIncidentMessage(String incidentMessage)`
`void`	`setIncidentMessageLike(String incidentMessageLike)`
`void`	`setIncidentType(String incidentType)`
`void`	`setLeafProcessInstances(Boolean leafProcessInstances)`
`void`	`setOrQueries(List<ProcessInstanceQueryDto> orQueries)`
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessDefinitionKey(String processDefinitionKey)`
`void`	`setProcessDefinitionKeyIn(List<String> processDefinitionKeyIn)`
`void`	`setProcessDefinitionKeyNotIn(List<String> processDefinitionKeyNotIn)`
`void`	`setProcessDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)`
`void`	`setProcessInstanceIds(List<String> processInstanceIds)`
`void`	`setRootProcessInstances(Boolean rootProcessInstances)`
`void`	`setSorting(List<ProcessInstanceQueryDtoSorting> sorting)`
`void`	`setSubCaseInstance(String subCaseInstance)`
`void`	`setSubProcessInstance(String subProcessInstance)`
`void`	`setSuperCaseInstance(String superCaseInstance)`
`void`	`setSuperProcessInstance(String superProcessInstance)`
`void`	`setSuspended(Boolean suspended)`
`void`	`setTenantIdIn(List<String> tenantIdIn)`
`void`	`setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)`
`void`	`setVariables(List<VariableQueryParameterDto> variables)`
`void`	`setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)`
`void`	`setWithIncident(Boolean withIncident)`
`void`	`setWithoutTenantId(Boolean withoutTenantId)`
`ProcessInstanceQueryDto`	`sorting(List<ProcessInstanceQueryDtoSorting> sorting)`
`ProcessInstanceQueryDto`	`subCaseInstance(String subCaseInstance)`
`ProcessInstanceQueryDto`	`subProcessInstance(String subProcessInstance)`
`ProcessInstanceQueryDto`	`superCaseInstance(String superCaseInstance)`
`ProcessInstanceQueryDto`	`superProcessInstance(String superProcessInstance)`
`ProcessInstanceQueryDto`	`suspended(Boolean suspended)`
`ProcessInstanceQueryDto`	`tenantIdIn(List<String> tenantIdIn)`
`String`	`toString()`
`ProcessInstanceQueryDto`	`variableNamesIgnoreCase(Boolean variableNamesIgnoreCase)`
`ProcessInstanceQueryDto`	`variables(List<VariableQueryParameterDto> variables)`
`ProcessInstanceQueryDto`	`variableValuesIgnoreCase(Boolean variableValuesIgnoreCase)`
`ProcessInstanceQueryDto`	`withIncident(Boolean withIncident)`
`ProcessInstanceQueryDto`	`withoutTenantId(Boolean withoutTenantId)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_DEPLOYMENT_ID

public static final String SERIALIZED_NAME_DEPLOYMENT_ID

See Also:: Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_ID

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID

See Also:: Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_KEY

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_KEY

See Also:: Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_KEY_IN

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_KEY_IN

See Also:: Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_KEY_NOT_IN

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_KEY_NOT_IN

See Also:: Constant Field Values

SERIALIZED_NAME_BUSINESS_KEY

public static final String SERIALIZED_NAME_BUSINESS_KEY

See Also:: Constant Field Values

SERIALIZED_NAME_BUSINESS_KEY_LIKE

public static final String SERIALIZED_NAME_BUSINESS_KEY_LIKE

See Also:: Constant Field Values

SERIALIZED_NAME_CASE_INSTANCE_ID

public static final String SERIALIZED_NAME_CASE_INSTANCE_ID

See Also:: Constant Field Values

SERIALIZED_NAME_SUPER_PROCESS_INSTANCE

public static final String SERIALIZED_NAME_SUPER_PROCESS_INSTANCE

See Also:: Constant Field Values

SERIALIZED_NAME_SUB_PROCESS_INSTANCE

public static final String SERIALIZED_NAME_SUB_PROCESS_INSTANCE

See Also:: Constant Field Values

SERIALIZED_NAME_SUPER_CASE_INSTANCE

public static final String SERIALIZED_NAME_SUPER_CASE_INSTANCE

See Also:: Constant Field Values

SERIALIZED_NAME_SUB_CASE_INSTANCE

public static final String SERIALIZED_NAME_SUB_CASE_INSTANCE

See Also:: Constant Field Values

SERIALIZED_NAME_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

See Also:: Constant Field Values

SERIALIZED_NAME_SUSPENDED

public static final String SERIALIZED_NAME_SUSPENDED

See Also:: Constant Field Values

SERIALIZED_NAME_PROCESS_INSTANCE_IDS

public static final String SERIALIZED_NAME_PROCESS_INSTANCE_IDS

See Also:: Constant Field Values

SERIALIZED_NAME_WITH_INCIDENT

public static final String SERIALIZED_NAME_WITH_INCIDENT

See Also:: Constant Field Values

SERIALIZED_NAME_INCIDENT_ID

public static final String SERIALIZED_NAME_INCIDENT_ID

See Also:: Constant Field Values

SERIALIZED_NAME_INCIDENT_TYPE

public static final String SERIALIZED_NAME_INCIDENT_TYPE

See Also:: Constant Field Values

SERIALIZED_NAME_INCIDENT_MESSAGE

public static final String SERIALIZED_NAME_INCIDENT_MESSAGE

See Also:: Constant Field Values

SERIALIZED_NAME_INCIDENT_MESSAGE_LIKE

public static final String SERIALIZED_NAME_INCIDENT_MESSAGE_LIKE

See Also:: Constant Field Values

SERIALIZED_NAME_TENANT_ID_IN

public static final String SERIALIZED_NAME_TENANT_ID_IN

See Also:: Constant Field Values

SERIALIZED_NAME_WITHOUT_TENANT_ID

public static final String SERIALIZED_NAME_WITHOUT_TENANT_ID

See Also:: Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_WITHOUT_TENANT_ID

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_WITHOUT_TENANT_ID

See Also:: Constant Field Values

SERIALIZED_NAME_ACTIVITY_ID_IN

public static final String SERIALIZED_NAME_ACTIVITY_ID_IN

See Also:: Constant Field Values

SERIALIZED_NAME_ROOT_PROCESS_INSTANCES

public static final String SERIALIZED_NAME_ROOT_PROCESS_INSTANCES

See Also:: Constant Field Values

SERIALIZED_NAME_LEAF_PROCESS_INSTANCES

public static final String SERIALIZED_NAME_LEAF_PROCESS_INSTANCES

See Also:: Constant Field Values

SERIALIZED_NAME_VARIABLES

public static final String SERIALIZED_NAME_VARIABLES

See Also:: Constant Field Values

SERIALIZED_NAME_VARIABLE_NAMES_IGNORE_CASE

public static final String SERIALIZED_NAME_VARIABLE_NAMES_IGNORE_CASE

See Also:: Constant Field Values

SERIALIZED_NAME_VARIABLE_VALUES_IGNORE_CASE

public static final String SERIALIZED_NAME_VARIABLE_VALUES_IGNORE_CASE

See Also:: Constant Field Values

SERIALIZED_NAME_OR_QUERIES

public static final String SERIALIZED_NAME_OR_QUERIES

See Also:: Constant Field Values

SERIALIZED_NAME_SORTING

public static final String SERIALIZED_NAME_SORTING

See Also:: Constant Field Values

Constructor Detail
- ProcessInstanceQueryDto
```
public ProcessInstanceQueryDto()
```

Method Detail

deploymentId

public ProcessInstanceQueryDto deploymentId(String deploymentId)

getDeploymentId
```
@Nullable
public String getDeploymentId()
```
Filter by the deployment the id belongs to.

Returns:

deploymentId

setDeploymentId

public void setDeploymentId(String deploymentId)

processDefinitionId

public ProcessInstanceQueryDto processDefinitionId(String processDefinitionId)

getProcessDefinitionId
```
@Nullable
public String getProcessDefinitionId()
```
Filter by the process definition the instances run on.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

processDefinitionKey

public ProcessInstanceQueryDto processDefinitionKey(String processDefinitionKey)

getProcessDefinitionKey
```
@Nullable
public String getProcessDefinitionKey()
```
Filter by the key of the process definition the instances run on.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(String processDefinitionKey)

processDefinitionKeyIn

public ProcessInstanceQueryDto processDefinitionKeyIn(List<String> processDefinitionKeyIn)

addProcessDefinitionKeyInItem

public ProcessInstanceQueryDto addProcessDefinitionKeyInItem(String processDefinitionKeyInItem)

getProcessDefinitionKeyIn
```
@Nullable
public List<String> getProcessDefinitionKeyIn()
```
Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Must be a JSON array of Strings.

Returns:

processDefinitionKeyIn

setProcessDefinitionKeyIn

public void setProcessDefinitionKeyIn(List<String> processDefinitionKeyIn)

processDefinitionKeyNotIn

public ProcessInstanceQueryDto processDefinitionKeyNotIn(List<String> processDefinitionKeyNotIn)

addProcessDefinitionKeyNotInItem

public ProcessInstanceQueryDto addProcessDefinitionKeyNotInItem(String processDefinitionKeyNotInItem)

getProcessDefinitionKeyNotIn
```
@Nullable
public List<String> getProcessDefinitionKeyNotIn()
```
Exclude instances by a list of process definition keys. A process instance must not have one of the given process definition keys. Must be a JSON array of Strings.

Returns:

processDefinitionKeyNotIn

setProcessDefinitionKeyNotIn

public void setProcessDefinitionKeyNotIn(List<String> processDefinitionKeyNotIn)

businessKey

public ProcessInstanceQueryDto businessKey(String businessKey)

getBusinessKey
```
@Nullable
public String getBusinessKey()
```
Filter by process instance business key.

Returns:

businessKey

setBusinessKey

public void setBusinessKey(String businessKey)

businessKeyLike

public ProcessInstanceQueryDto businessKeyLike(String businessKeyLike)

getBusinessKeyLike
```
@Nullable
public String getBusinessKeyLike()
```
Filter by process instance business key that the parameter is a substring of.

Returns:

businessKeyLike

setBusinessKeyLike

public void setBusinessKeyLike(String businessKeyLike)

caseInstanceId

public ProcessInstanceQueryDto caseInstanceId(String caseInstanceId)

getCaseInstanceId
```
@Nullable
public String getCaseInstanceId()
```
Filter by case instance id.

Returns:

caseInstanceId

setCaseInstanceId

public void setCaseInstanceId(String caseInstanceId)

superProcessInstance

public ProcessInstanceQueryDto superProcessInstance(String superProcessInstance)

getSuperProcessInstance
```
@Nullable
public String getSuperProcessInstance()
```
Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id.

Returns:

superProcessInstance

setSuperProcessInstance

public void setSuperProcessInstance(String superProcessInstance)

subProcessInstance

public ProcessInstanceQueryDto subProcessInstance(String subProcessInstance)

getSubProcessInstance
```
@Nullable
public String getSubProcessInstance()
```
Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id.

Returns:

subProcessInstance

setSubProcessInstance

public void setSubProcessInstance(String subProcessInstance)

superCaseInstance

public ProcessInstanceQueryDto superCaseInstance(String superCaseInstance)

getSuperCaseInstance
```
@Nullable
public String getSuperCaseInstance()
```
Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.

Returns:

superCaseInstance

setSuperCaseInstance

public void setSuperCaseInstance(String superCaseInstance)

subCaseInstance

public ProcessInstanceQueryDto subCaseInstance(String subCaseInstance)

getSubCaseInstance
```
@Nullable
public String getSubCaseInstance()
```
Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id.

Returns:

subCaseInstance

setSubCaseInstance

public void setSubCaseInstance(String subCaseInstance)

active

public ProcessInstanceQueryDto active(Boolean active)

getActive
```
@Nullable
public Boolean getActive()
```
Only include active process instances. Value may only be true, as false is the default behavior.

Returns:

active

setActive

public void setActive(Boolean active)

suspended

public ProcessInstanceQueryDto suspended(Boolean suspended)

getSuspended
```
@Nullable
public Boolean getSuspended()
```
Only include suspended process instances. Value may only be true, as false is the default behavior.

Returns:

suspended

setSuspended

public void setSuspended(Boolean suspended)

processInstanceIds

public ProcessInstanceQueryDto processInstanceIds(List<String> processInstanceIds)

addProcessInstanceIdsItem

public ProcessInstanceQueryDto addProcessInstanceIdsItem(String processInstanceIdsItem)

getProcessInstanceIds
```
@Nullable
public List<String> getProcessInstanceIds()
```
Filter by a list of process instance ids. Must be a JSON array of Strings.

Returns:

processInstanceIds

setProcessInstanceIds

public void setProcessInstanceIds(List<String> processInstanceIds)

withIncident

public ProcessInstanceQueryDto withIncident(Boolean withIncident)

getWithIncident
```
@Nullable
public Boolean getWithIncident()
```
Filter by presence of incidents. Selects only process instances that have an incident.

Returns:

withIncident

setWithIncident

public void setWithIncident(Boolean withIncident)

incidentId

public ProcessInstanceQueryDto incidentId(String incidentId)

getIncidentId
```
@Nullable
public String getIncidentId()
```
Filter by the incident id.

Returns:

incidentId

setIncidentId

public void setIncidentId(String incidentId)

incidentType

public ProcessInstanceQueryDto incidentType(String incidentType)

getIncidentType
```
@Nullable
public String getIncidentType()
```
Filter by the incident type. See the User Guide for a list of incident types.

Returns:

incidentType

setIncidentType

public void setIncidentType(String incidentType)

incidentMessage

public ProcessInstanceQueryDto incidentMessage(String incidentMessage)

getIncidentMessage
```
@Nullable
public String getIncidentMessage()
```
Filter by the incident message. Exact match.

Returns:

incidentMessage

setIncidentMessage

public void setIncidentMessage(String incidentMessage)

incidentMessageLike

public ProcessInstanceQueryDto incidentMessageLike(String incidentMessageLike)

getIncidentMessageLike
```
@Nullable
public String getIncidentMessageLike()
```
Filter by the incident message that the parameter is a substring of.

Returns:

incidentMessageLike

setIncidentMessageLike

public void setIncidentMessageLike(String incidentMessageLike)

tenantIdIn

public ProcessInstanceQueryDto tenantIdIn(List<String> tenantIdIn)

addTenantIdInItem

public ProcessInstanceQueryDto addTenantIdInItem(String tenantIdInItem)

getTenantIdIn
```
@Nullable
public List<String> getTenantIdIn()
```
Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Must be a JSON array of Strings.

Returns:

tenantIdIn

setTenantIdIn

public void setTenantIdIn(List<String> tenantIdIn)

withoutTenantId

public ProcessInstanceQueryDto withoutTenantId(Boolean withoutTenantId)

getWithoutTenantId
```
@Nullable
public Boolean getWithoutTenantId()
```
Only include process instances which belong to no tenant. Value may only be true, as false is the default behavior.

Returns:

withoutTenantId

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

processDefinitionWithoutTenantId

public ProcessInstanceQueryDto processDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)

getProcessDefinitionWithoutTenantId
```
@Nullable
public Boolean getProcessDefinitionWithoutTenantId()
```
Only include process instances which process definition has no tenant id.

Returns:

processDefinitionWithoutTenantId

setProcessDefinitionWithoutTenantId

public void setProcessDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)

activityIdIn

public ProcessInstanceQueryDto activityIdIn(List<String> activityIdIn)

addActivityIdInItem

public ProcessInstanceQueryDto addActivityIdInItem(String activityIdInItem)

getActivityIdIn
```
@Nullable
public List<String> getActivityIdIn()
```
Filter by a list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids.

Returns:

activityIdIn

setActivityIdIn

public void setActivityIdIn(List<String> activityIdIn)

rootProcessInstances

public ProcessInstanceQueryDto rootProcessInstances(Boolean rootProcessInstances)

getRootProcessInstances
```
@Nullable
public Boolean getRootProcessInstances()
```
Restrict the query to all process instances that are top level process instances.

Returns:

rootProcessInstances

setRootProcessInstances

public void setRootProcessInstances(Boolean rootProcessInstances)

leafProcessInstances

public ProcessInstanceQueryDto leafProcessInstances(Boolean leafProcessInstances)

getLeafProcessInstances
```
@Nullable
public Boolean getLeafProcessInstances()
```
Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances)

Returns:

leafProcessInstances

setLeafProcessInstances

public void setLeafProcessInstances(Boolean leafProcessInstances)

variables

public ProcessInstanceQueryDto variables(List<VariableQueryParameterDto> variables)

addVariablesItem

public ProcessInstanceQueryDto addVariablesItem(VariableQueryParameterDto variablesItem)

getVariables
```
@Nullable
public List<VariableQueryParameterDto> getVariables()
```
A JSON array to only include process instances that have variables with certain values. The array consists of objects with the three properties `name`, `operator` and `value`. `name` (String) is the variable name, `operator` (String) is the comparison operator to be used and `value` the variable value. The `value` may be String, Number or Boolean. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`.

Returns:

variables

setVariables

public void setVariables(List<VariableQueryParameterDto> variables)

variableNamesIgnoreCase

public ProcessInstanceQueryDto variableNamesIgnoreCase(Boolean variableNamesIgnoreCase)

getVariableNamesIgnoreCase
```
@Nullable
public Boolean getVariableNamesIgnoreCase()
```
Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal.

Returns:

variableNamesIgnoreCase

setVariableNamesIgnoreCase

public void setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)

variableValuesIgnoreCase

public ProcessInstanceQueryDto variableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

getVariableValuesIgnoreCase
```
@Nullable
public Boolean getVariableValuesIgnoreCase()
```
Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal.

Returns:

variableValuesIgnoreCase

setVariableValuesIgnoreCase

public void setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

orQueries

public ProcessInstanceQueryDto orQueries(List<ProcessInstanceQueryDto> orQueries)

addOrQueriesItem

public ProcessInstanceQueryDto addOrQueriesItem(ProcessInstanceQueryDto orQueriesItem)

getOrQueries
```
@Nullable
public List<ProcessInstanceQueryDto> getOrQueries()
```
A JSON array of nested process instance queries with OR semantics. A process instance matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a process instance must fulfill at least one predicate of each query (Conjunctive Normal Form). All process instance query properties can be used except for: `sorting` See the [User guide](https://docs.camunda.org/manual/7.15/user-guide/process-engine/process-engine-api/#or-queries) for more information about OR queries.

Returns:

orQueries

setOrQueries

public void setOrQueries(List<ProcessInstanceQueryDto> orQueries)

sorting

public ProcessInstanceQueryDto sorting(List<ProcessInstanceQueryDtoSorting> sorting)

addSortingItem

public ProcessInstanceQueryDto addSortingItem(ProcessInstanceQueryDtoSorting sortingItem)

getSorting

@Nullable
public List<ProcessInstanceQueryDtoSorting> getSorting()

Apply sorting of the result

Returns:: sorting

setSorting

public void setSorting(List<ProcessInstanceQueryDtoSorting> sorting)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class ProcessInstanceQueryDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_DEPLOYMENT_ID

SERIALIZED_NAME_PROCESS_DEFINITION_ID

SERIALIZED_NAME_PROCESS_DEFINITION_KEY

SERIALIZED_NAME_PROCESS_DEFINITION_KEY_IN

SERIALIZED_NAME_PROCESS_DEFINITION_KEY_NOT_IN

SERIALIZED_NAME_BUSINESS_KEY

SERIALIZED_NAME_BUSINESS_KEY_LIKE

SERIALIZED_NAME_CASE_INSTANCE_ID

SERIALIZED_NAME_SUPER_PROCESS_INSTANCE

SERIALIZED_NAME_SUB_PROCESS_INSTANCE

SERIALIZED_NAME_SUPER_CASE_INSTANCE

SERIALIZED_NAME_SUB_CASE_INSTANCE

SERIALIZED_NAME_ACTIVE

SERIALIZED_NAME_SUSPENDED

SERIALIZED_NAME_PROCESS_INSTANCE_IDS

SERIALIZED_NAME_WITH_INCIDENT

SERIALIZED_NAME_INCIDENT_ID

SERIALIZED_NAME_INCIDENT_TYPE

SERIALIZED_NAME_INCIDENT_MESSAGE

SERIALIZED_NAME_INCIDENT_MESSAGE_LIKE

SERIALIZED_NAME_TENANT_ID_IN

SERIALIZED_NAME_WITHOUT_TENANT_ID

SERIALIZED_NAME_PROCESS_DEFINITION_WITHOUT_TENANT_ID

SERIALIZED_NAME_ACTIVITY_ID_IN

SERIALIZED_NAME_ROOT_PROCESS_INSTANCES

SERIALIZED_NAME_LEAF_PROCESS_INSTANCES

SERIALIZED_NAME_VARIABLES

SERIALIZED_NAME_VARIABLE_NAMES_IGNORE_CASE

SERIALIZED_NAME_VARIABLE_VALUES_IGNORE_CASE

SERIALIZED_NAME_OR_QUERIES

SERIALIZED_NAME_SORTING

Constructor Detail

ProcessInstanceQueryDto

Method Detail

deploymentId

getDeploymentId

setDeploymentId

processDefinitionId

getProcessDefinitionId

setProcessDefinitionId

processDefinitionKey

getProcessDefinitionKey

setProcessDefinitionKey

processDefinitionKeyIn

addProcessDefinitionKeyInItem

getProcessDefinitionKeyIn

setProcessDefinitionKeyIn

processDefinitionKeyNotIn

addProcessDefinitionKeyNotInItem

getProcessDefinitionKeyNotIn

setProcessDefinitionKeyNotIn

businessKey

getBusinessKey

setBusinessKey

businessKeyLike

getBusinessKeyLike

setBusinessKeyLike

caseInstanceId

getCaseInstanceId

setCaseInstanceId

superProcessInstance

getSuperProcessInstance

setSuperProcessInstance

subProcessInstance

getSubProcessInstance

setSubProcessInstance

superCaseInstance

getSuperCaseInstance

setSuperCaseInstance

subCaseInstance

getSubCaseInstance

setSubCaseInstance

active

getActive