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

Class CleanableHistoricProcessInstanceReportDto

java.lang.Object

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

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

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

public class CleanableHistoricProcessInstanceReportDto
extends AbstractQueryDto<CleanableHistoricProcessInstanceReport>

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	compact
protected String[]	processDefinitionIdIn
protected String[]	processDefinitionKeyIn
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
CleanableHistoricProcessInstanceReportDto()
CleanableHistoricProcessInstanceReportDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(CleanableHistoricProcessInstanceReport query)
protected void	applySortBy(CleanableHistoricProcessInstanceReport query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected CleanableHistoricProcessInstanceReport	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setCompact(Boolean compact)
void	setProcessDefinitionIdIn(String[] processDefinitionIdIn)
void	setProcessDefinitionKeyIn(String[] processDefinitionKeyIn)
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

processDefinitionIdIn

protected String[] processDefinitionIdIn

processDefinitionKeyIn

protected String[] processDefinitionKeyIn

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

CleanableHistoricProcessInstanceReportDto

public CleanableHistoricProcessInstanceReportDto()

CleanableHistoricProcessInstanceReportDto

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

Method Details

setProcessDefinitionIdIn

public void setProcessDefinitionIdIn(String[] processDefinitionIdIn)

setProcessDefinitionKeyIn

public void setProcessDefinitionKeyIn(String[] processDefinitionKeyIn)

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<CleanableHistoricProcessInstanceReport>

createNewQuery

protected CleanableHistoricProcessInstanceReport createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<CleanableHistoricProcessInstanceReport>

applyFilters

protected void applyFilters(CleanableHistoricProcessInstanceReport query)

Specified by:

applyFilters in class AbstractQueryDto<CleanableHistoricProcessInstanceReport>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<CleanableHistoricProcessInstanceReport>