org.camunda.bpm.cockpit.rest.dto

Class AbstractRestQueryParametersDto<T>

java.lang.Object

org.camunda.bpm.engine.impl.db.AuthorizationCheck

org.camunda.bpm.engine.impl.db.ListQueryParameterObject

org.camunda.bpm.cockpit.db.QueryParameters<T>

org.camunda.bpm.cockpit.rest.dto.AbstractRestQueryParametersDto<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IncidentQueryDto, ProcessDefinitionQueryDto, ProcessInstanceQueryDto

public abstract class AbstractRestQueryParametersDto<T>
extends QueryParameters<T>

Author:

roman.smirnov

See Also:

Serialized Form

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

Fields inherited from class org.camunda.bpm.cockpit.db.QueryParameters

historyEnabled

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

databaseType, firstResult, maxResults, parameter

Fields inherited from class org.camunda.bpm.engine.impl.db.AuthorizationCheck

authDefaultPerm, authGroupIds, authPerms, authResourceId, authResourceIdQueryParam, authResourceType, authUserId, isAuthorizationCheckEnabled

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getOrderBy()
protected abstract String	getOrderByValue(String sortBy)
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()

Methods inherited from class org.camunda.bpm.cockpit.db.QueryParameters

isHistoryEnabled, setHistoryEnabled

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getParameter, setDatabaseType, setFirstResult, setMaxResults, setParameter

Methods inherited from class org.camunda.bpm.engine.impl.db.AuthorizationCheck

getAuthDefaultPerm, getAuthGroupIds, getAuthPerms, getAuthResourceId, getAuthResourceIdQueryParam, getAuthResourceType, getAuthUserId, isAuthorizationCheckEnabled, setAuthDefaultPerm, setAuthGroupIds, setAuthorizationCheckEnabled, setAuthPerms, setAuthResourceId, setAuthResourceIdQueryParam, setAuthResourceType, setAuthUserId

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

AbstractRestQueryParametersDto

public AbstractRestQueryParametersDto()

AbstractRestQueryParametersDto

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

Method Detail

setSortBy

public void setSortBy(String sortBy)

setSortOrder

public void setSortOrder(String sortOrder)

sortOptionsValid

protected boolean sortOptionsValid()

getOrderBy

public String getOrderBy()

Overrides:

getOrderBy in class ListQueryParameterObject

getOrderByValue

protected abstract String getOrderByValue(String sortBy)

isValidSortByValue

protected abstract boolean isValidSortByValue(String value)

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 -