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

Class HistoricBatchQueryDto

java.lang.Object

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

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

org.camunda.bpm.engine.rest.dto.history.batch.HistoricBatchQueryDto

public class HistoricBatchQueryDto
extends AbstractQueryDto<HistoricBatchQuery>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	batchId
protected Boolean	completed
protected List<String>	tenantIds
protected String	type
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
HistoricBatchQueryDto()
HistoricBatchQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(HistoricBatchQuery query)
protected void	applySortBy(HistoricBatchQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected HistoricBatchQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setBatchId(String batchId)
void	setCompleted(Boolean completed)
void	setTenantIdIn(List<String> tenantIds)
void	setType(String type)
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

batchId

protected String batchId

type

protected String type

completed

protected Boolean completed

tenantIds

protected List<String> tenantIds

withoutTenantId

protected Boolean withoutTenantId

Constructor Details

HistoricBatchQueryDto

public HistoricBatchQueryDto()

HistoricBatchQueryDto

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

Method Details

setBatchId

public void setBatchId(String batchId)

setType

public void setType(String type)

setCompleted

public void setCompleted(Boolean completed)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<HistoricBatchQuery>

createNewQuery

protected HistoricBatchQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<HistoricBatchQuery>

applyFilters

protected void applyFilters(HistoricBatchQuery query)

Specified by:

applyFilters in class AbstractQueryDto<HistoricBatchQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<HistoricBatchQuery>