Package com.bellotapps.webapps_commons.persistence.repository_utils

Interface PagingRequest

public interface PagingRequest

Defines behaviour for an object that contains information that can be used to request a Page or a Slice to a repository, including sorting information.

Method Summary

Modifier and Type	Method	Description
static PagingRequest	of(int pageNumber, int pageSize, SortingData sortingData)	Creates a new PagingRequest.
long	offset()
int	pageNumber()
int	pageSize()
SortingData	sortBy()
static PagingRequest	unsorted(int pageNumber, int pageSize)	Creates a new PagingRequest that contains no sorting data.

Method Detail

pageNumber

int pageNumber()

Returns:

The number of the Page or Slice that is being requested.

pageSize

int pageSize()

Returns:

The size of the Page or Slice being requested.

offset

long offset()

Returns:

The offset to be taken according to the underlying Page or Slice number and size.

sortBy

SortingData sortBy()

Returns:

The SortingData to be passed to a repository.

of

static PagingRequest of(int pageNumber,
                        int pageSize,
                        SortingData sortingData)

Creates a new PagingRequest.

Parameters:

pageNumber - The number of the Page or Slice that is being requested.

pageSize - The size of the Page or Slice being requested.

sortingData - The SortingData to be passed to a repository when querying.

Returns:

A PagingRequest with the specified paging and sorting data.

unsorted

static PagingRequest unsorted(int pageNumber,
                              int pageSize)

Creates a new PagingRequest that contains no sorting data.

Parameters:

pageNumber - The number of the Page or Slice that is being requested.

pageSize - The size of the Page or Slice being requested.

Returns:

A PagingRequest with no sorting data.