Package org.camunda.bpm.engine.rest.dto
Class AbstractQueryDto<T extends Query<?,?>>
java.lang.Object
org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto
org.camunda.bpm.engine.rest.dto.AbstractQueryDto<T>
- Direct Known Subclasses:
AuthorizationQueryDto
,BatchQueryDto
,BatchStatisticsQueryDto
,CaseDefinitionQueryDto
,CaseExecutionQueryDto
,CaseInstanceQueryDto
,CleanableHistoricBatchReportDto
,CleanableHistoricCaseInstanceReportDto
,CleanableHistoricDecisionInstanceReportDto
,CleanableHistoricProcessInstanceReportDto
,DecisionDefinitionQueryDto
,DecisionRequirementsDefinitionQueryDto
,DeploymentQueryDto
,EventSubscriptionQueryDto
,ExecutionQueryDto
,ExternalTaskQueryDto
,FilterQueryDto
,GroupQueryDto
,HistoricActivityInstanceQueryDto
,HistoricActivityStatisticsQueryDto
,HistoricBatchQueryDto
,HistoricCaseActivityInstanceQueryDto
,HistoricCaseInstanceQueryDto
,HistoricDecisionInstanceQueryDto
,HistoricDetailQueryDto
,HistoricExternalTaskLogQueryDto
,HistoricIdentityLinkLogQueryDto
,HistoricIncidentQueryDto
,HistoricJobLogQueryDto
,HistoricProcessInstanceQueryDto
,HistoricTaskInstanceQueryDto
,HistoricVariableInstanceQueryDto
,IncidentQueryDto
,JobDefinitionQueryDto
,JobQueryDto
,ProcessDefinitionQueryDto
,ProcessInstanceQueryDto
,SchemaLogQueryDto
,TaskQueryDto
,TenantQueryDto
,UserOperationLogQueryDto
,UserQueryDto
,VariableInstanceQueryDto
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
Modifier and TypeFieldDescriptionstatic final String
static final String
protected String
protected List<SortingDto>
protected String
Fields inherited from class org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto
objectMapper
-
Constructor Summary
ConstructorDescriptionAbstractQueryDto
(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String, String> queryParameters) -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
applyFilters
(T query) protected abstract void
applySortBy
(T query, String sortBy, Map<String, Object> parameters, ProcessEngine engine) protected void
applySortingOptions
(T query, ProcessEngine engine) protected void
applySortOrder
(T query, String sortOrder) protected abstract T
createNewQuery
(ProcessEngine engine) protected abstract boolean
isValidSortByValue
(String value) void
void
setSorting
(List<SortingDto> sorting) void
setSortOrder
(String sortOrder) protected boolean
static String
sortOrderValueForDirection
(Direction direction) toQuery
(ProcessEngine engine) Methods inherited from class org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto
setObjectMapper, setValueBasedOnAnnotation
-
Field Details
-
SORT_ORDER_ASC_VALUE
- See Also:
-
SORT_ORDER_DESC_VALUE
- See Also:
-
VALID_SORT_ORDER_VALUES
-
sortBy
-
sortOrder
-
sortings
-
expressions
-
-
Constructor Details
-
AbstractQueryDto
public AbstractQueryDto() -
AbstractQueryDto
-
-
Method Details
-
setSortBy
-
setSortOrder
-
setSorting
-
getSorting
-
isValidSortByValue
-
sortOptionsValid
protected boolean sortOptionsValid() -
toQuery
-
createNewQuery
-
applyFilters
-
applySortingOptions
-
applySortBy
-
applySortOrder
-
sortOrderValueForDirection
-