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

Class BatchQueryDto

java.lang.Object

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

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

org.camunda.bpm.engine.rest.dto.batch.BatchQueryDto

public class BatchQueryDto
extends AbstractQueryDto<BatchQuery>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(BatchQuery query)
protected void	applySortBy(BatchQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected BatchQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setBatchId(String batchId)
void	setSuspended(Boolean suspended)
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

tenantIds

protected List<String> tenantIds

withoutTenantId

protected Boolean withoutTenantId

suspended

protected Boolean suspended

Constructor Details

BatchQueryDto

public BatchQueryDto(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)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

setSuspended

public void setSuspended(Boolean suspended)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<BatchQuery>

createNewQuery

protected BatchQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<BatchQuery>

applyFilters

protected void applyFilters(BatchQuery query)

Specified by:

applyFilters in class AbstractQueryDto<BatchQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<BatchQuery>