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

Class CaseInstanceQueryDto

java.lang.Object

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

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

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

public class CaseInstanceQueryDto
extends AbstractQueryDto<CaseInstanceQuery>

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	active
protected String	businessKey
protected String	caseDefinitionId
protected String	caseDefinitionKey
protected String	caseInstanceId
protected Boolean	completed
protected String	deploymentId
protected static final String	SORT_BY_DEFINITION_ID_VALUE
protected static final String	SORT_BY_DEFINITION_KEY_VALUE
protected static final String	SORT_BY_INSTANCE_ID_VALUE
protected static final String	SORT_BY_TENANT_ID
protected String	subCaseInstance
protected String	subProcessInstance
protected String	superCaseInstance
protected String	superProcessInstance
protected List<String>	tenantIds
protected Boolean	terminated
protected static final List<String>	VALID_SORT_BY_VALUES
protected Boolean	variableNamesIgnoreCase
protected List<VariableQueryParameterDto>	variables
protected Boolean	variableValuesIgnoreCase
protected Boolean	withoutTenantId

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
CaseInstanceQueryDto()
CaseInstanceQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(CaseInstanceQuery query)
protected void	applySortBy(CaseInstanceQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected CaseInstanceQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setActive(Boolean active)
void	setBusinessKey(String businessKey)
void	setCaseDefinitionId(String caseDefinitionId)
void	setCaseDefinitionKey(String caseDefinitionKey)
void	setCaseInstanceId(String caseInstanceId)
void	setCompleted(Boolean completed)
void	setDeploymentId(String deploymentId)
void	setSubCaseInstance(String subCaseInstance)
void	setSubProcessInstance(String subProcessInstance)
void	setSuperCaseInstance(String superCaseInstance)
void	setSuperProcessInstance(String superProcessInstance)
void	setTenantIdIn(List<String> tenantIds)
void	setTerminated(Boolean terminated)
void	setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)
void	setVariables(List<VariableQueryParameterDto> variables)
void	setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)
void	setWithoutTenantId(Boolean withoutTenantId)

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_INSTANCE_ID_VALUE

protected static final String SORT_BY_INSTANCE_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

caseInstanceId

protected String caseInstanceId

businessKey

protected String businessKey

caseDefinitionKey

protected String caseDefinitionKey

caseDefinitionId

protected String caseDefinitionId

deploymentId

protected String deploymentId

superProcessInstance

protected String superProcessInstance

subProcessInstance

protected String subProcessInstance

superCaseInstance

protected String superCaseInstance

subCaseInstance

protected String subCaseInstance

tenantIds

protected List<String> tenantIds

withoutTenantId

protected Boolean withoutTenantId

active

protected Boolean active

completed

protected Boolean completed

terminated

protected Boolean terminated

variables

protected List<VariableQueryParameterDto> variables

variableNamesIgnoreCase

protected Boolean variableNamesIgnoreCase

variableValuesIgnoreCase

protected Boolean variableValuesIgnoreCase

Constructor Details

CaseInstanceQueryDto

public CaseInstanceQueryDto()

CaseInstanceQueryDto

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

Method Details

setCaseInstanceId

public void setCaseInstanceId(String caseInstanceId)

setBusinessKey

public void setBusinessKey(String businessKey)

setCaseDefinitionKey

public void setCaseDefinitionKey(String caseDefinitionKey)

setCaseDefinitionId

public void setCaseDefinitionId(String caseDefinitionId)

setDeploymentId

public void setDeploymentId(String deploymentId)

setSuperProcessInstance

public void setSuperProcessInstance(String superProcessInstance)

setSubProcessInstance

public void setSubProcessInstance(String subProcessInstance)

setSuperCaseInstance

public void setSuperCaseInstance(String superCaseInstance)

setSubCaseInstance

public void setSubCaseInstance(String subCaseInstance)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

setActive

public void setActive(Boolean active)

setCompleted

public void setCompleted(Boolean completed)

setTerminated

public void setTerminated(Boolean terminated)

setVariables

public void setVariables(List<VariableQueryParameterDto> variables)

setVariableNamesIgnoreCase

public void setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)

setVariableValuesIgnoreCase

public void setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<CaseInstanceQuery>

createNewQuery

protected CaseInstanceQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<CaseInstanceQuery>

applyFilters

protected void applyFilters(CaseInstanceQuery query)

Specified by:

applyFilters in class AbstractQueryDto<CaseInstanceQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<CaseInstanceQuery>