Package org.camunda.bpm.engine.rest.dto.runtime

Class VariableInstanceQueryDto

java.lang.Object

org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

org.camunda.bpm.engine.rest.dto.AbstractQueryDto<VariableInstanceQuery>

org.camunda.bpm.engine.rest.dto.runtime.VariableInstanceQueryDto

public class VariableInstanceQueryDto
extends AbstractQueryDto<VariableInstanceQuery>

Author:

roman.smirnov

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	activityInstanceIdIn
protected String[]	batchIdIn
protected String[]	caseExecutionIdIn
protected String[]	caseInstanceIdIn
protected String[]	executionIdIn
protected String[]	processInstanceIdIn
protected String[]	taskIdIn
protected String	variableName
protected String	variableNameLike
protected Boolean	variableNamesIgnoreCase
protected String[]	variableScopeIdIn
protected List<VariableQueryParameterDto>	variableValues
protected Boolean	variableValuesIgnoreCase

Fields inherited from class org.camunda.bpm.engine.rest.dto.AbstractQueryDto

expressions, SORT_ORDER_ASC_VALUE, SORT_ORDER_DESC_VALUE, sortBy, sortings, sortOrder, VALID_SORT_ORDER_VALUES

Fields inherited from class org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

objectMapper

Constructor Summary

Constructors

Constructor	Description
VariableInstanceQueryDto()
VariableInstanceQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(VariableInstanceQuery query)
protected void	applySortBy(VariableInstanceQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected VariableInstanceQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setActivityInstanceIdIn(String[] activityInstanceIdIn)
void	setBatchIdIn(String[] batchIdIn)
void	setCaseExecutionIdIn(String[] caseExecutionIdIn)
void	setCaseInstanceIdIn(String[] caseInstanceIdIn)
void	setExecutionIdIn(String[] executionIdIn)
void	setProcessInstanceIdIn(String[] processInstanceIdIn)
void	setTaskIdIn(String[] taskIdIn)
void	setTenantIdIn(List<String> tenantIds)
void	setVariableName(String variableName)
void	setVariableNameLike(String variableNameLike)
void	setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)
void	setVariableScopeIdIn(String[] variableScopeIdIn)
void	setVariableValues(List<VariableQueryParameterDto> variableValues)
void	setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

Methods inherited from class org.camunda.bpm.engine.rest.dto.AbstractQueryDto

applySortingOptions, applySortOrder, getSorting, setSortBy, setSorting, setSortOrder, sortOptionsValid, sortOrderValueForDirection, toQuery

Methods inherited from class org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

setObjectMapper, setValueBasedOnAnnotation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

variableName

protected String variableName

variableNameLike

protected String variableNameLike

variableValues

protected List<VariableQueryParameterDto> variableValues

variableNamesIgnoreCase

protected Boolean variableNamesIgnoreCase

variableValuesIgnoreCase

protected Boolean variableValuesIgnoreCase

executionIdIn

protected String[] executionIdIn

processInstanceIdIn

protected String[] processInstanceIdIn

caseExecutionIdIn

protected String[] caseExecutionIdIn

caseInstanceIdIn

protected String[] caseInstanceIdIn

taskIdIn

protected String[] taskIdIn

batchIdIn

protected String[] batchIdIn

variableScopeIdIn

protected String[] variableScopeIdIn

activityInstanceIdIn

protected String[] activityInstanceIdIn

Constructor Details

VariableInstanceQueryDto

public VariableInstanceQueryDto()

VariableInstanceQueryDto

public VariableInstanceQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Details

setVariableName

public void setVariableName(String variableName)

setVariableNameLike

public void setVariableNameLike(String variableNameLike)

setVariableValues

public void setVariableValues(List<VariableQueryParameterDto> variableValues)

setVariableNamesIgnoreCase

public void setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)

setVariableValuesIgnoreCase

public void setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

setExecutionIdIn

public void setExecutionIdIn(String[] executionIdIn)

setProcessInstanceIdIn

public void setProcessInstanceIdIn(String[] processInstanceIdIn)

setCaseExecutionIdIn

public void setCaseExecutionIdIn(String[] caseExecutionIdIn)

setCaseInstanceIdIn

public void setCaseInstanceIdIn(String[] caseInstanceIdIn)

setTaskIdIn

public void setTaskIdIn(String[] taskIdIn)

setBatchIdIn

public void setBatchIdIn(String[] batchIdIn)

setVariableScopeIdIn

public void setVariableScopeIdIn(String[] variableScopeIdIn)

setActivityInstanceIdIn

public void setActivityInstanceIdIn(String[] activityInstanceIdIn)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<VariableInstanceQuery>

createNewQuery

protected VariableInstanceQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<VariableInstanceQuery>

applyFilters

protected void applyFilters(VariableInstanceQuery query)

Specified by:

applyFilters in class AbstractQueryDto<VariableInstanceQuery>

applySortBy

protected void applySortBy(VariableInstanceQuery query,
 String sortBy,
 Map<String,Object> parameters,
 ProcessEngine engine)

Specified by:

applySortBy in class AbstractQueryDto<VariableInstanceQuery>