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

Class CleanableHistoricCaseInstanceReportDto

java.lang.Object

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

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

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

public class CleanableHistoricCaseInstanceReportDto
extends AbstractQueryDto<CleanableHistoricCaseInstanceReport>

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	caseDefinitionIdIn
protected String[]	caseDefinitionKeyIn
protected Boolean	compact
protected static final String	SORT_BY_FINISHED_VALUE
protected String[]	tenantIdIn
static final List<String>	VALID_SORT_BY_VALUES
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
CleanableHistoricCaseInstanceReportDto()
CleanableHistoricCaseInstanceReportDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(CleanableHistoricCaseInstanceReport query)
protected void	applySortBy(CleanableHistoricCaseInstanceReport query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected CleanableHistoricCaseInstanceReport	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setCaseDefinitionIdIn(String[] caseDefinitionIdIn)
void	setCaseDefinitionKeyIn(String[] caseDefinitionKeyIn)
void	setCompact(Boolean compact)
void	setTenantIdIn(String[] tenantIdIn)
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

caseDefinitionIdIn

protected String[] caseDefinitionIdIn

caseDefinitionKeyIn

protected String[] caseDefinitionKeyIn

tenantIdIn

protected String[] tenantIdIn

withoutTenantId

protected Boolean withoutTenantId

compact

protected Boolean compact

SORT_BY_FINISHED_VALUE

protected static final String SORT_BY_FINISHED_VALUE

See Also:

• Constant Field Values

VALID_SORT_BY_VALUES

public static final List<String> VALID_SORT_BY_VALUES

Constructor Details

CleanableHistoricCaseInstanceReportDto

public CleanableHistoricCaseInstanceReportDto()

CleanableHistoricCaseInstanceReportDto

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

Method Details

setCaseDefinitionIdIn

public void setCaseDefinitionIdIn(String[] caseDefinitionIdIn)

setCaseDefinitionKeyIn

public void setCaseDefinitionKeyIn(String[] caseDefinitionKeyIn)

setTenantIdIn

public void setTenantIdIn(String[] tenantIdIn)

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

setCompact

public void setCompact(Boolean compact)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<CleanableHistoricCaseInstanceReport>

createNewQuery

protected CleanableHistoricCaseInstanceReport createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<CleanableHistoricCaseInstanceReport>

applyFilters

protected void applyFilters(CleanableHistoricCaseInstanceReport query)

Specified by:

applyFilters in class AbstractQueryDto<CleanableHistoricCaseInstanceReport>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<CleanableHistoricCaseInstanceReport>