Class QueryParams<T extends QueryField>
java.lang.Object
org.alfresco.module.org_alfresco_module_rm.util.dao.QueryParams<T>
Options when listing something.
- Since:
- 2.6
- Author:
- Tom Page
-
Constructor Summary
ConstructorsConstructorDescriptionQueryParams
(List<Pair<T, Boolean>> sortProps) Constructor that takes the sort order. -
Method Summary
Modifier and TypeMethodDescriptionint
Get the total number of items to return (assuming enough are available).int
Get the number of items to skip before creating the list.Get the ordered list of columns to sort on (and their sort direction).void
setSortProps
(List<Pair<T, Boolean>> sortProps) Sets the sort properties required and validates the list.withMaxItems
(int maxItems) Sets the max items count required.withSkipCount
(int skipCount) Sets the skip count required.withSortProps
(List<Pair<T, Boolean>> sortProps) Sets the sort properties required.
-
Constructor Details
-
QueryParams
Constructor that takes the sort order.- Parameters:
sortProps
- A list of fields to sort on, and the direction to sort in.
-
-
Method Details
-
withSkipCount
Sets the skip count required. -
withMaxItems
Sets the max items count required. -
withSortProps
Sets the sort properties required.- Parameters:
sortProps
- A list of pairs of properties and sort directions.- Returns:
- The updated QueryParams object.
-
setSortProps
Sets the sort properties required and validates the list.- Parameters:
sortProps
- A list of pairs of properties and sort directions.
-
getSortProps
Get the ordered list of columns to sort on (and their sort direction). -
getSkipCount
public int getSkipCount()Get the number of items to skip before creating the list. -
getMaxItems
public int getMaxItems()Get the total number of items to return (assuming enough are available).
-