org.camunda.bpm.engine.rest.dto

Class AbstractQueryDto<T extends Query<?,?>>

java.lang.Object

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

Direct Known Subclasses:

AuthorizationQueryDto, ExecutionQueryDto, GroupQueryDto, HistoricActivityInstanceQueryDto, HistoricDetailQueryDto, HistoricIncidentQueryDto, HistoricProcessInstanceQueryDto, HistoricTaskInstanceQueryDto, HistoricVariableInstanceQueryDto, IncidentQueryDto, JobDefinitionQueryDto, JobQueryDto, ProcessDefinitionQueryDto, ProcessInstanceQueryDto, TaskQueryDto, UserOperationLogQueryDto, UserQueryDto, VariableInstanceQueryDto

public abstract class AbstractQueryDto<T extends Query<?,?>>
extends Object

Defines common query operations, such as sorting options and validation. Also allows to access its setter methods based on CamundaQueryParam annotations which is used for processing Http query parameters.

Author:

Thorben Lindhauer

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SORT_ORDER_ASC_VALUE
protected static String	SORT_ORDER_DESC_VALUE
protected String	sortBy
protected String	sortOrder

Constructor Summary

Constructors

Constructor and Description
AbstractQueryDto()
AbstractQueryDto(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	applyFilters(T query)
protected abstract void	applySortingOptions(T query)
protected abstract T	createNewQuery(ProcessEngine engine)
protected abstract boolean	isValidSortByValue(String value)
void	setSortBy(String sortBy)
void	setSortOrder(String sortOrder)
protected void	setValueBasedOnAnnotation(String key, String value) Finds the methods that are annotated with a CamundaQueryParam with a value that matches the key parameter.
protected boolean	sortOptionsValid()
T	toQuery(ProcessEngine engine)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SORT_ORDER_ASC_VALUE

protected static final String SORT_ORDER_ASC_VALUE

See Also:

Constant Field Values

SORT_ORDER_DESC_VALUE

protected static final String SORT_ORDER_DESC_VALUE

See Also:

Constant Field Values

sortBy

protected String sortBy

sortOrder

protected String sortOrder

Constructor Detail

AbstractQueryDto

public AbstractQueryDto()

AbstractQueryDto

public AbstractQueryDto(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Detail

setSortBy

public void setSortBy(String sortBy)

setSortOrder

public void setSortOrder(String sortOrder)

isValidSortByValue

protected abstract boolean isValidSortByValue(String value)

sortOptionsValid

protected boolean sortOptionsValid()

setValueBasedOnAnnotation

protected void setValueBasedOnAnnotation(String key,
                             String value)

Finds the methods that are annotated with a CamundaQueryParam with a value that matches the key parameter. Before invoking these methods, the annotated StringToTypeConverter is used to convert the String value to the desired Java type.

Parameters:

key -

value -

toQuery

public T toQuery(ProcessEngine engine)

createNewQuery

protected abstract T createNewQuery(ProcessEngine engine)

applyFilters

protected abstract void applyFilters(T query)

applySortingOptions

protected abstract void applySortingOptions(T query)