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 java.lang.Boolean	compact
protected java.lang.String[]	processDefinitionIdIn
protected java.lang.String[]	processDefinitionKeyIn
protected static java.lang.String	SORT_BY_FINISHED_VALUE
protected java.lang.String[]	tenantIdIn
static java.util.List<java.lang.String>	VALID_SORT_BY_VALUES
protected java.lang.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, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> queryParameters)

Method Summary

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

processDefinitionIdIn

protected java.lang.String[] processDefinitionIdIn

processDefinitionKeyIn

protected java.lang.String[] processDefinitionKeyIn

tenantIdIn

protected java.lang.String[] tenantIdIn

withoutTenantId

protected java.lang.Boolean withoutTenantId

compact

protected java.lang.Boolean compact

SORT_BY_FINISHED_VALUE

protected static final java.lang.String SORT_BY_FINISHED_VALUE

See Also:

Constant Field Values

VALID_SORT_BY_VALUES

public static final java.util.List<java.lang.String> VALID_SORT_BY_VALUES

Constructor Detail

CleanableHistoricProcessInstanceReportDto

public CleanableHistoricProcessInstanceReportDto()

CleanableHistoricProcessInstanceReportDto

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

Method Detail

setProcessDefinitionIdIn

public void setProcessDefinitionIdIn(java.lang.String[] processDefinitionIdIn)

setProcessDefinitionKeyIn

public void setProcessDefinitionKeyIn(java.lang.String[] processDefinitionKeyIn)

setTenantIdIn

public void setTenantIdIn(java.lang.String[] tenantIdIn)

setWithoutTenantId

public void setWithoutTenantId(java.lang.Boolean withoutTenantId)

setCompact

public void setCompact(java.lang.Boolean compact)

isValidSortByValue

protected boolean isValidSortByValue(java.lang.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,
                           java.lang.String sortBy,
                           java.util.Map<java.lang.String,java.lang.Object> parameters,
                           ProcessEngine engine)

Specified by:

applySortBy in class AbstractQueryDto<CleanableHistoricProcessInstanceReport>