Interface PageRequest
-
- All Known Subinterfaces:
SearchPageRequest
- All Known Implementing Classes:
PageRequestImpl,SearchPageRequestImpl
public interface PageRequestAbstract interface for pagination information. See Spring Data Commons, but more flat design and independent of Spring libraries.Container for paging, sorting and filtering params:
- pageNumber: which page to be returned
- pageSize: how many items on one page
- sorting: container for sorting order of result list
- filtering: container for filter criterias of result list
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classPageRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static PageRequest.BuilderdefaultBuilder()PageRequestfirst()FilteringgetFiltering()intgetOffset()intgetPageNumber()intgetPageSize()SortinggetSorting()booleanhasPrevious()Returns whether there's a previousPageRequestwe can access from the current one.PageRequestnext()PageRequestpreviousOrFirst()voidsetFiltering(Filtering filtering)voidsetPageNumber(int pageNumber)voidsetPageSize(int pageSize)voidsetSorting(Sorting sorting)
-
-
-
Method Detail
-
defaultBuilder
static PageRequest.Builder defaultBuilder()
-
first
PageRequest first()
- Returns:
- the
PageRequestrequesting the first page
-
setFiltering
void setFiltering(Filtering filtering)
- Parameters:
filtering- the filtering criterias
-
getFiltering
Filtering getFiltering()
- Returns:
- the filtering parameters
-
getOffset
int getOffset()
- Returns:
- the offset to be taken according to the underlying page and page size.
-
setPageNumber
void setPageNumber(int pageNumber)
- Parameters:
pageNumber- the page to be returned
-
getPageNumber
int getPageNumber()
- Returns:
- the page to be returned.
-
setPageSize
void setPageSize(int pageSize)
- Parameters:
pageSize- the number of items of that page
-
getPageSize
int getPageSize()
- Returns:
- the number of items of that page
-
setSorting
void setSorting(Sorting sorting)
- Parameters:
sorting- the sorting parameters
-
getSorting
Sorting getSorting()
- Returns:
- the sorting parameters
-
hasPrevious
boolean hasPrevious()
Returns whether there's a previousPageRequestwe can access from the current one. Will return false in case the currentPageRequestalready refers to the first page.- Returns:
- whether there's a previous PageRequest
-
next
PageRequest next()
- Returns:
- the
PageRequestrequesting the next page
-
previousOrFirst
PageRequest previousOrFirst()
- Returns:
- the previous
PageRequestor the firstPageRequestif the current one already is the first one
-
-