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

Class CaseExecutionQueryDto

java.lang.Object

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

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

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

public class CaseExecutionQueryDto
extends AbstractQueryDto<CaseExecutionQuery>

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	active
protected String	activityId
protected String	businessKey
protected String	caseDefinitionId
protected String	caseDefinitionKey
protected String	caseExecutionId
protected String	caseInstanceId
protected List<VariableQueryParameterDto>	caseInstanceVariables
protected Boolean	disabled
protected Boolean	enabled
protected Boolean	required
protected static final String	SORT_BY_DEFINITION_ID_VALUE
protected static final String	SORT_BY_DEFINITION_KEY_VALUE
protected static final String	SORT_BY_EXECUTION_ID_VALUE
protected static final String	SORT_BY_TENANT_ID
protected List<String>	tenantIds
protected static final List<String>	VALID_SORT_BY_VALUES
protected Boolean	variableNamesIgnoreCase
protected List<VariableQueryParameterDto>	variables
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
CaseExecutionQueryDto()
CaseExecutionQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(CaseExecutionQuery query)
protected void	applySortBy(CaseExecutionQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected CaseExecutionQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setActive(Boolean active)
void	setActivityId(String activityId)
void	setBusinessKey(String businessKey)
void	setCaseDefinitionId(String caseDefinitionId)
void	setCaseDefinitionKey(String caseDefinitionKey)
void	setCaseExecutionId(String caseExecutionId)
void	setCaseInstanceId(String caseInstanceId)
void	setCaseInstanceVariables(List<VariableQueryParameterDto> caseInstanceVariables)
void	setDisabled(Boolean disabled)
void	setEnabled(Boolean enabled)
void	setRequired(Boolean required)
void	setTenantIdIn(List<String> tenantIds)
void	setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)
void	setVariables(List<VariableQueryParameterDto> variables)
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

SORT_BY_EXECUTION_ID_VALUE

protected static final String SORT_BY_EXECUTION_ID_VALUE

See Also:

• Constant Field Values

SORT_BY_DEFINITION_KEY_VALUE

protected static final String SORT_BY_DEFINITION_KEY_VALUE

See Also:

• Constant Field Values

SORT_BY_DEFINITION_ID_VALUE

protected static final String SORT_BY_DEFINITION_ID_VALUE

See Also:

• Constant Field Values

SORT_BY_TENANT_ID

protected static final String SORT_BY_TENANT_ID

See Also:

• Constant Field Values

VALID_SORT_BY_VALUES

protected static final List<String> VALID_SORT_BY_VALUES

caseExecutionId

protected String caseExecutionId

caseDefinitionKey

protected String caseDefinitionKey

caseDefinitionId

protected String caseDefinitionId

caseInstanceId

protected String caseInstanceId

businessKey

protected String businessKey

activityId

protected String activityId

tenantIds

protected List<String> tenantIds

required

protected Boolean required

enabled

protected Boolean enabled

active

protected Boolean active

disabled

protected Boolean disabled

variables

protected List<VariableQueryParameterDto> variables

caseInstanceVariables

protected List<VariableQueryParameterDto> caseInstanceVariables

variableNamesIgnoreCase

protected Boolean variableNamesIgnoreCase

variableValuesIgnoreCase

protected Boolean variableValuesIgnoreCase

Constructor Details

CaseExecutionQueryDto

public CaseExecutionQueryDto()

CaseExecutionQueryDto

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

Method Details

setCaseExecutionId

public void setCaseExecutionId(String caseExecutionId)

setCaseDefinitionKey

public void setCaseDefinitionKey(String caseDefinitionKey)

setCaseDefinitionId

public void setCaseDefinitionId(String caseDefinitionId)

setCaseInstanceId

public void setCaseInstanceId(String caseInstanceId)

setBusinessKey

public void setBusinessKey(String businessKey)

setActivityId

public void setActivityId(String activityId)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setRequired

public void setRequired(Boolean required)

setEnabled

public void setEnabled(Boolean enabled)

setActive

public void setActive(Boolean active)

setDisabled

public void setDisabled(Boolean disabled)

setVariables

public void setVariables(List<VariableQueryParameterDto> variables)

setVariableNamesIgnoreCase

public void setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)

setVariableValuesIgnoreCase

public void setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

setCaseInstanceVariables

public void setCaseInstanceVariables(List<VariableQueryParameterDto> caseInstanceVariables)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<CaseExecutionQuery>

createNewQuery

protected CaseExecutionQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<CaseExecutionQuery>

applyFilters

protected void applyFilters(CaseExecutionQuery query)

Specified by:

applyFilters in class AbstractQueryDto<CaseExecutionQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<CaseExecutionQuery>