M
- Provide entity specific type checking, for example, when we create QueryParameters
instance for Users, M is equal to UserModel, hence we are not able, for example, to order result by a
SearchableModelField
defined for clients in ClientModel
.public class QueryParameters<M> extends Object
Modifier and Type | Class and Description |
---|---|
static class |
QueryParameters.Order
Enum for ascending or descending ordering
|
static class |
QueryParameters.OrderBy<M>
Wrapper class for a field with its
Order , ascending or descending |
Constructor and Description |
---|
QueryParameters() |
QueryParameters(ModelCriteriaBuilder<M> mcb) |
Modifier and Type | Method and Description |
---|---|
Integer |
getLimit() |
ModelCriteriaBuilder<M> |
getModelCriteriaBuilder() |
Integer |
getOffset() |
List<QueryParameters.OrderBy<M>> |
getOrderBy() |
QueryParameters<M> |
limit(Integer limit)
Sets limit parameter
|
QueryParameters<M> |
offset(Integer offset)
Sets offset parameter
|
QueryParameters<M> |
orderBy(SearchableModelField<M> searchableModelField,
QueryParameters.Order order)
Sets orderBy parameter; can be called repeatedly; fields are stored in a list where the first field has highest
priority when determining order; e.g.
|
QueryParameters<M> |
pagination(Integer offset,
Integer limit,
SearchableModelField<M> orderByAscField)
Sets pagination (offset, limit and orderBy) parameters to
QueryParameters |
static <M> QueryParameters<M> |
withCriteria(ModelCriteriaBuilder<M> mcb)
Creates a new
QueryParameters instance initialized with ModelCriteriaBuilder |
public QueryParameters()
public QueryParameters(ModelCriteriaBuilder<M> mcb)
public static <M> QueryParameters<M> withCriteria(ModelCriteriaBuilder<M> mcb)
QueryParameters
instance initialized with ModelCriteriaBuilder
M
- model typemcb
- filtering criteriaQueryParameters
instancepublic QueryParameters<M> pagination(Integer offset, Integer limit, SearchableModelField<M> orderByAscField)
QueryParameters
offset
- limit
- orderByAscField
- public QueryParameters<M> orderBy(SearchableModelField<M> searchableModelField, QueryParameters.Order order)
searchableModelField
- public QueryParameters<M> offset(Integer offset)
offset
- public QueryParameters<M> limit(Integer limit)
limit
- public Integer getOffset()
public Integer getLimit()
public ModelCriteriaBuilder<M> getModelCriteriaBuilder()
public List<QueryParameters.OrderBy<M>> getOrderBy()
Copyright © 2021 JBoss by Red Hat. All rights reserved.