QueryParams

public class QueryParams implements Serializable

Utility class containing parameters which control order and size of query results. Used mainly for paging/ordering queries from the UI.

Fields

ORDER_ID_ASC

public static final QueryParams ORDER_ID_ASC

Constant query parameter, that orders records ascending by ID.

Constructors

QueryParams

public QueryParams(Integer page, Integer pageSize)

Creates query parameters.

Parameters:

• page – number of page
• pageSize – amount of entries to include, per page

QueryParams

public QueryParams(Order order)

Creates query parameters.

Parameters:

• order – specifies order of the records

QueryParams

public QueryParams(List<Order> orderList)

Creates query parameters.

Parameters:

• orderList – the list of order instructions that will be applied to the query

QueryParams

public QueryParams(Integer page, Integer pageSize, Order order)

Creates query parameters.

Parameters:

• page – number of page
• pageSize – amount of entries to include, per page
• order – specifies order of the records

QueryParams

public QueryParams(Integer page, Integer pageSize, List<Order> orderList)

Creates query parameters.

Parameters:

• page – number of page
• pageSize – amount of entries to include, per page
• orderList – the list of order instructions that will be applied to the query

Methods

addOrder

public void addOrder(Order order)

ascOrder

public static QueryParams ascOrder(String field)

Creates query parameter that sorts records ascending, by the given field.

Parameters:

• field – field to sort records by

Returns:

query parameter, ordering records ascending

containsOrderOnField

public boolean containsOrderOnField(String fieldName)

descOrder

public static QueryParams descOrder(String field)

Creates query parameter that sorts records descending, by the given field.

Parameters:

• field – field to sort records by

Returns:

query parameter, ordering records descending

getOrderList

public List<Order> getOrderList()

getPage

public Integer getPage()

getPageSize

public Integer getPageSize()

isOrderSet

public boolean isOrderSet()

isPagingSet

public boolean isPagingSet()