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

Class FilterQueryDto

java.lang.Object

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

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

org.camunda.bpm.engine.rest.dto.runtime.FilterQueryDto

public class FilterQueryDto
extends AbstractQueryDto<FilterQuery>

Author:

Sebastian Menski

Field Summary

Fields

Modifier and Type	Field	Description
protected String	filterId
protected String	name
protected String	nameLike
protected String	owner
protected String	resourceType
static final String	SORT_BY_ID_VALUE
static final String	SORT_BY_NAME_VALUE
static final String	SORT_BY_OWNER_VALUE
static final String	SORT_BY_RESOURCE_TYPE_VALUE

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
FilterQueryDto()
FilterQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(FilterQuery query)
protected void	applySortBy(FilterQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected FilterQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setFilterId(String filterId)
void	setName(String name)
void	setNameLike(String nameLike)
void	setOwner(String owner)
void	setResourceType(String resourceType)

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

SORT_BY_ID_VALUE

public static final String SORT_BY_ID_VALUE

See Also:

• Constant Field Values

SORT_BY_RESOURCE_TYPE_VALUE

public static final String SORT_BY_RESOURCE_TYPE_VALUE

See Also:

• Constant Field Values

SORT_BY_NAME_VALUE

public static final String SORT_BY_NAME_VALUE

See Also:

• Constant Field Values

SORT_BY_OWNER_VALUE

public static final String SORT_BY_OWNER_VALUE

See Also:

• Constant Field Values

filterId

protected String filterId

resourceType

protected String resourceType

name

protected String name

nameLike

protected String nameLike

owner

protected String owner

Constructor Details

FilterQueryDto

public FilterQueryDto()

FilterQueryDto

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

Method Details

setFilterId

public void setFilterId(String filterId)

setResourceType

public void setResourceType(String resourceType)

setName

public void setName(String name)

setNameLike

public void setNameLike(String nameLike)

setOwner

public void setOwner(String owner)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<FilterQuery>

createNewQuery

protected FilterQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<FilterQuery>

applyFilters

protected void applyFilters(FilterQuery query)

Specified by:

applyFilters in class AbstractQueryDto<FilterQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<FilterQuery>