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

Class HistoricCaseInstanceQueryDto

java.lang.Object

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

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

org.camunda.bpm.engine.rest.dto.history.HistoricCaseInstanceQueryDto

public class HistoricCaseInstanceQueryDto
extends AbstractQueryDto<HistoricCaseInstanceQuery>

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	active
List<String>	caseActivityIdIn
String	caseDefinitionId
String	caseDefinitionKey
List<String>	caseDefinitionKeyNotIn
String	caseDefinitionName
String	caseDefinitionNameLike
String	caseInstanceBusinessKey
String	caseInstanceBusinessKeyLike
String	caseInstanceId
Set<String>	caseInstanceIds
Boolean	closed
Date	closedAfter
Date	closedBefore
Boolean	completed
Date	createdAfter
Date	createdBefore
String	createdBy
Boolean	notClosed
static final String	SORT_BY_CASE_DEFINITION_ID_VALUE
static final String	SORT_BY_CASE_INSTANCE_BUSINESS_KEY_VALUE
static final String	SORT_BY_CASE_INSTANCE_CLOSE_TIME_VALUE
static final String	SORT_BY_CASE_INSTANCE_CREATE_TIME_VALUE
static final String	SORT_BY_CASE_INSTANCE_DURATION_VALUE
static final String	SORT_BY_CASE_INSTANCE_ID_VALUE
String	subCaseInstanceId
String	superCaseInstanceId
Boolean	terminated
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
HistoricCaseInstanceQueryDto()
HistoricCaseInstanceQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(HistoricCaseInstanceQuery query)
protected void	applySortBy(HistoricCaseInstanceQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected HistoricCaseInstanceQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setActive(Boolean active)
void	setCaseActivityIdIn(List<String> caseActivityIdIn)
void	setCaseDefinitionId(String caseDefinitionId)
void	setCaseDefinitionKey(String caseDefinitionKey)
void	setCaseDefinitionKeyNotIn(List<String> caseDefinitionKeys)
void	setCaseDefinitionName(String caseDefinitionName)
void	setCaseDefinitionNameLike(String caseDefinitionNameLike)
void	setCaseInstanceBusinessKey(String caseInstanceBusinessKey)
void	setCaseInstanceBusinessKeyLike(String caseInstanceBusinessKeyLike)
void	setCaseInstanceId(String caseInstanceId)
void	setCaseInstanceIds(Set<String> caseInstanceIds)
void	setClosed(Boolean closed)
void	setClosedAfter(Date closedAfter)
void	setClosedBefore(Date closedBefore)
void	setCompleted(Boolean completed)
void	setCreatedAfter(Date createdAfter)
void	setCreatedBefore(Date createdBefore)
void	setCreatedBy(String createdBy)
void	setNotClosed(Boolean notClosed)
void	setSubCaseInstanceId(String subCaseInstanceId)
void	setSubProcessInstanceId(String subProcessInstanceId)
void	setSuperCaseInstanceId(String superCaseInstanceId)
void	setSuperProcessInstanceId(String superProcessInstanceId)
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_CASE_INSTANCE_ID_VALUE

public static final String SORT_BY_CASE_INSTANCE_ID_VALUE

See Also:

• Constant Field Values

SORT_BY_CASE_DEFINITION_ID_VALUE

public static final String SORT_BY_CASE_DEFINITION_ID_VALUE

See Also:

• Constant Field Values

SORT_BY_CASE_INSTANCE_BUSINESS_KEY_VALUE

public static final String SORT_BY_CASE_INSTANCE_BUSINESS_KEY_VALUE

See Also:

• Constant Field Values

SORT_BY_CASE_INSTANCE_CREATE_TIME_VALUE

public static final String SORT_BY_CASE_INSTANCE_CREATE_TIME_VALUE

See Also:

• Constant Field Values

SORT_BY_CASE_INSTANCE_CLOSE_TIME_VALUE

public static final String SORT_BY_CASE_INSTANCE_CLOSE_TIME_VALUE

See Also:

• Constant Field Values

SORT_BY_CASE_INSTANCE_DURATION_VALUE

public static final String SORT_BY_CASE_INSTANCE_DURATION_VALUE

See Also:

• Constant Field Values

VALID_SORT_BY_VALUES

public static final List<String> VALID_SORT_BY_VALUES

caseInstanceId

public String caseInstanceId

caseInstanceIds

public Set<String> caseInstanceIds

caseDefinitionId

public String caseDefinitionId

caseDefinitionKey

public String caseDefinitionKey

caseDefinitionName

public String caseDefinitionName

caseDefinitionNameLike

public String caseDefinitionNameLike

caseDefinitionKeyNotIn

public List<String> caseDefinitionKeyNotIn

caseInstanceBusinessKey

public String caseInstanceBusinessKey

caseInstanceBusinessKeyLike

public String caseInstanceBusinessKeyLike

superCaseInstanceId

public String superCaseInstanceId

subCaseInstanceId

public String subCaseInstanceId

createdBy

public String createdBy

caseActivityIdIn

public List<String> caseActivityIdIn

createdBefore

public Date createdBefore

createdAfter

public Date createdAfter

closedBefore

public Date closedBefore

closedAfter

public Date closedAfter

active

public Boolean active

completed

public Boolean completed

terminated

public Boolean terminated

closed

public Boolean closed

notClosed

public Boolean notClosed

variables

protected List<VariableQueryParameterDto> variables

variableValuesIgnoreCase

protected Boolean variableValuesIgnoreCase

variableNamesIgnoreCase

protected Boolean variableNamesIgnoreCase

Constructor Details

HistoricCaseInstanceQueryDto

public HistoricCaseInstanceQueryDto()

HistoricCaseInstanceQueryDto

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

Method Details

setCaseInstanceId

public void setCaseInstanceId(String caseInstanceId)

setCaseInstanceIds

public void setCaseInstanceIds(Set<String> caseInstanceIds)

setCaseDefinitionId

public void setCaseDefinitionId(String caseDefinitionId)

setCaseDefinitionName

public void setCaseDefinitionName(String caseDefinitionName)

setCaseDefinitionNameLike

public void setCaseDefinitionNameLike(String caseDefinitionNameLike)

setCaseDefinitionKey

public void setCaseDefinitionKey(String caseDefinitionKey)

setCaseDefinitionKeyNotIn

public void setCaseDefinitionKeyNotIn(List<String> caseDefinitionKeys)

setCaseInstanceBusinessKey

public void setCaseInstanceBusinessKey(String caseInstanceBusinessKey)

setCaseInstanceBusinessKeyLike

public void setCaseInstanceBusinessKeyLike(String caseInstanceBusinessKeyLike)

setSuperCaseInstanceId

public void setSuperCaseInstanceId(String superCaseInstanceId)

setSubCaseInstanceId

public void setSubCaseInstanceId(String subCaseInstanceId)

setSuperProcessInstanceId

public void setSuperProcessInstanceId(String superProcessInstanceId)

setSubProcessInstanceId

public void setSubProcessInstanceId(String subProcessInstanceId)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

setCreatedBy

public void setCreatedBy(String createdBy)

setCreatedBefore

public void setCreatedBefore(Date createdBefore)

setCreatedAfter

public void setCreatedAfter(Date createdAfter)

setClosedBefore

public void setClosedBefore(Date closedBefore)

setClosedAfter

public void setClosedAfter(Date closedAfter)

setActive

public void setActive(Boolean active)

setCompleted

public void setCompleted(Boolean completed)

setTerminated

public void setTerminated(Boolean terminated)

setClosed

public void setClosed(Boolean closed)

setNotClosed

public void setNotClosed(Boolean notClosed)

setVariables

public void setVariables(List<VariableQueryParameterDto> variables)

setVariableValuesIgnoreCase

public void setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

setVariableNamesIgnoreCase

public void setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)

setCaseActivityIdIn

public void setCaseActivityIdIn(List<String> caseActivityIdIn)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<HistoricCaseInstanceQuery>

createNewQuery

protected HistoricCaseInstanceQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<HistoricCaseInstanceQuery>

applyFilters

protected void applyFilters(HistoricCaseInstanceQuery query)

Specified by:

applyFilters in class AbstractQueryDto<HistoricCaseInstanceQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<HistoricCaseInstanceQuery>