Package org.openapitools.client.model
Class VariableInstanceQueryDto
- java.lang.Object
-
- org.openapitools.client.model.VariableInstanceQueryDto
-
public class VariableInstanceQueryDto extends Object
A variable instance query which defines a list of variable instances
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERIALIZED_NAME_ACTIVITY_INSTANCE_ID_INstatic StringSERIALIZED_NAME_BATCH_ID_INstatic StringSERIALIZED_NAME_CASE_EXECUTION_ID_INstatic StringSERIALIZED_NAME_CASE_INSTANCE_ID_INstatic StringSERIALIZED_NAME_EXECUTION_ID_INstatic StringSERIALIZED_NAME_PROCESS_INSTANCE_ID_INstatic StringSERIALIZED_NAME_SORTINGstatic StringSERIALIZED_NAME_TASK_ID_INstatic StringSERIALIZED_NAME_TENANT_ID_INstatic StringSERIALIZED_NAME_VARIABLE_NAMEstatic StringSERIALIZED_NAME_VARIABLE_NAME_LIKEstatic StringSERIALIZED_NAME_VARIABLE_NAMES_IGNORE_CASEstatic StringSERIALIZED_NAME_VARIABLE_SCOPE_ID_INstatic StringSERIALIZED_NAME_VARIABLE_VALUESstatic StringSERIALIZED_NAME_VARIABLE_VALUES_IGNORE_CASE
-
Constructor Summary
Constructors Constructor Description VariableInstanceQueryDto()
-
Method Summary
-
-
-
Field Detail
-
SERIALIZED_NAME_VARIABLE_NAME
public static final String SERIALIZED_NAME_VARIABLE_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VARIABLE_NAME_LIKE
public static final String SERIALIZED_NAME_VARIABLE_NAME_LIKE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PROCESS_INSTANCE_ID_IN
public static final String SERIALIZED_NAME_PROCESS_INSTANCE_ID_IN
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EXECUTION_ID_IN
public static final String SERIALIZED_NAME_EXECUTION_ID_IN
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CASE_INSTANCE_ID_IN
public static final String SERIALIZED_NAME_CASE_INSTANCE_ID_IN
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CASE_EXECUTION_ID_IN
public static final String SERIALIZED_NAME_CASE_EXECUTION_ID_IN
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TASK_ID_IN
public static final String SERIALIZED_NAME_TASK_ID_IN
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BATCH_ID_IN
public static final String SERIALIZED_NAME_BATCH_ID_IN
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACTIVITY_INSTANCE_ID_IN
public static final String SERIALIZED_NAME_ACTIVITY_INSTANCE_ID_IN
- 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_VARIABLE_VALUES
public static final String SERIALIZED_NAME_VARIABLE_VALUES
- 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_VARIABLE_SCOPE_ID_IN
public static final String SERIALIZED_NAME_VARIABLE_SCOPE_ID_IN
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SORTING
public static final String SERIALIZED_NAME_SORTING
- See Also:
- Constant Field Values
-
-
Method Detail
-
variableName
public VariableInstanceQueryDto variableName(String variableName)
-
getVariableName
public String getVariableName()
Filter by variable instance name.- Returns:
- variableName
-
setVariableName
public void setVariableName(String variableName)
-
variableNameLike
public VariableInstanceQueryDto variableNameLike(String variableNameLike)
-
getVariableNameLike
public String getVariableNameLike()
Filter by the variable instance name. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`).- Returns:
- variableNameLike
-
setVariableNameLike
public void setVariableNameLike(String variableNameLike)
-
processInstanceIdIn
public VariableInstanceQueryDto processInstanceIdIn(List<String> processInstanceIdIn)
-
addProcessInstanceIdInItem
public VariableInstanceQueryDto addProcessInstanceIdInItem(String processInstanceIdInItem)
-
getProcessInstanceIdIn
public List<String> getProcessInstanceIdIn()
Only include variable instances which belong to one of the passed process instance ids.- Returns:
- processInstanceIdIn
-
executionIdIn
public VariableInstanceQueryDto executionIdIn(List<String> executionIdIn)
-
addExecutionIdInItem
public VariableInstanceQueryDto addExecutionIdInItem(String executionIdInItem)
-
getExecutionIdIn
public List<String> getExecutionIdIn()
Only include variable instances which belong to one of the passed execution ids.- Returns:
- executionIdIn
-
caseInstanceIdIn
public VariableInstanceQueryDto caseInstanceIdIn(List<String> caseInstanceIdIn)
-
addCaseInstanceIdInItem
public VariableInstanceQueryDto addCaseInstanceIdInItem(String caseInstanceIdInItem)
-
getCaseInstanceIdIn
public List<String> getCaseInstanceIdIn()
Only include variable instances which belong to one of the passed case instance ids.- Returns:
- caseInstanceIdIn
-
caseExecutionIdIn
public VariableInstanceQueryDto caseExecutionIdIn(List<String> caseExecutionIdIn)
-
addCaseExecutionIdInItem
public VariableInstanceQueryDto addCaseExecutionIdInItem(String caseExecutionIdInItem)
-
getCaseExecutionIdIn
public List<String> getCaseExecutionIdIn()
Only include variable instances which belong to one of the passed case execution ids.- Returns:
- caseExecutionIdIn
-
taskIdIn
public VariableInstanceQueryDto taskIdIn(List<String> taskIdIn)
-
addTaskIdInItem
public VariableInstanceQueryDto addTaskIdInItem(String taskIdInItem)
-
getTaskIdIn
public List<String> getTaskIdIn()
Only include variable instances which belong to one of the passed task ids.- Returns:
- taskIdIn
-
batchIdIn
public VariableInstanceQueryDto batchIdIn(List<String> batchIdIn)
-
addBatchIdInItem
public VariableInstanceQueryDto addBatchIdInItem(String batchIdInItem)
-
getBatchIdIn
public List<String> getBatchIdIn()
Only include variable instances which belong to one of the passed batch ids.- Returns:
- batchIdIn
-
activityInstanceIdIn
public VariableInstanceQueryDto activityInstanceIdIn(List<String> activityInstanceIdIn)
-
addActivityInstanceIdInItem
public VariableInstanceQueryDto addActivityInstanceIdInItem(String activityInstanceIdInItem)
-
getActivityInstanceIdIn
public List<String> getActivityInstanceIdIn()
Only include variable instances which belong to one of the passed activity instance ids.- Returns:
- activityInstanceIdIn
-
tenantIdIn
public VariableInstanceQueryDto tenantIdIn(List<String> tenantIdIn)
-
addTenantIdInItem
public VariableInstanceQueryDto addTenantIdInItem(String tenantIdInItem)
-
getTenantIdIn
public List<String> getTenantIdIn()
Only include variable instances which belong to one of the passed tenant ids.- Returns:
- tenantIdIn
-
variableValues
public VariableInstanceQueryDto variableValues(List<VariableQueryParameterDto> variableValues)
-
addVariableValuesItem
public VariableInstanceQueryDto addVariableValuesItem(VariableQueryParameterDto variableValuesItem)
-
getVariableValues
public List<VariableQueryParameterDto> getVariableValues()
An array to only include variable instances that have the 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. `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:
- variableValues
-
setVariableValues
public void setVariableValues(List<VariableQueryParameterDto> variableValues)
-
variableNamesIgnoreCase
public VariableInstanceQueryDto variableNamesIgnoreCase(Boolean variableNamesIgnoreCase)
-
getVariableNamesIgnoreCase
public Boolean getVariableNamesIgnoreCase()
Match all variable names provided in `variableValues` case-insensitively. If set to `true` **variableName** and **variablename** are treated as equal.- Returns:
- variableNamesIgnoreCase
-
setVariableNamesIgnoreCase
public void setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)
-
variableValuesIgnoreCase
public VariableInstanceQueryDto variableValuesIgnoreCase(Boolean variableValuesIgnoreCase)
-
getVariableValuesIgnoreCase
public Boolean getVariableValuesIgnoreCase()
Match all variable values provided in `variableValues` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal.- Returns:
- variableValuesIgnoreCase
-
setVariableValuesIgnoreCase
public void setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)
-
variableScopeIdIn
public VariableInstanceQueryDto variableScopeIdIn(List<String> variableScopeIdIn)
-
addVariableScopeIdInItem
public VariableInstanceQueryDto addVariableScopeIdInItem(String variableScopeIdInItem)
-
getVariableScopeIdIn
public List<String> getVariableScopeIdIn()
Only include variable instances which belong to one of passed scope ids.- Returns:
- variableScopeIdIn
-
sorting
public VariableInstanceQueryDto sorting(List<VariableInstanceQueryDtoSorting> sorting)
-
addSortingItem
public VariableInstanceQueryDto addSortingItem(VariableInstanceQueryDtoSorting sortingItem)
-
getSorting
public List<VariableInstanceQueryDtoSorting> getSorting()
An array of criteria to sort the result by. Each element of the array is an object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Sorting has no effect for `count` endpoints- Returns:
- sorting
-
setSorting
public void setSorting(List<VariableInstanceQueryDtoSorting> sorting)
-
-