com.hybris.cockpitng.search.data.pageable

Interface Pageable<R>

All Superinterfaces:

IdentifiableSearchQuery

All Known Subinterfaces:

FullTextSearchPageable<R>

All Known Implementing Classes:

PageableList, PageableWithFullTextDataCallback

public interface Pageable<R>
extends IdentifiableSearchQuery

Capable of paging the collections of result type R.

Method Summary

Modifier and Type	Method and Description
List<R>	getAllResults() Returns all results on all pages.
List<R>	getCurrentPage() Gets the entries of the current record.
int	getPageNumber() Returns the active page number.
int	getPageSize() Returns the page size.
SortData	getSortData() Returns sort related information
int	getTotalCount() Returns count of all items in the collection that is being paged.
String	getTypeCode() Returns the "common" type code of all entries.
boolean	hasNextPage() Determines if there is a next page.
boolean	hasPreviousPage() Determines if there is a previous page.
List<R>	nextPage() Gets the entries of the next record page and updates the current page number (see getCurrentPage()).
List<R>	previousPage() Get the entries of the previous page and updates the current page number (see getCurrentPage()).
void	refresh() Refreshes current page.
void	setPageNumber(int pageNo) Sets the active page number.
List<R>	setPageSize(int pageSize) Changes the page size and returns the current page with a new page size.
default void	setQueryId(String queryId)
void	setSortData(SortData sortData)

Methods inherited from interface com.hybris.cockpitng.search.data.IdentifiableSearchQuery

getQueryId

Method Detail

getCurrentPage

List<R> getCurrentPage()

Gets the entries of the current record.

Returns:

all entries of the current record page

refresh

void refresh()

Refreshes current page.

nextPage

List<R> nextPage()

Gets the entries of the next record page and updates the current page number (see getCurrentPage()).

Returns:

all entries of the next record page or an empty list if hasNextPage() returns false

previousPage

List<R> previousPage()

Get the entries of the previous page and updates the current page number (see getCurrentPage()).

Returns:

List of RESULT or empty list if hasPreviousPage() returns false.

hasNextPage

boolean hasNextPage()

Determines if there is a next page.

Returns:

boolean

hasPreviousPage

boolean hasPreviousPage()

Determines if there is a previous page.

Returns:

boolean

getPageSize

int getPageSize()

Returns the page size.

Returns:

integer

getTypeCode

String getTypeCode()

Returns the "common" type code of all entries.

Returns:

the common type code or null if no common type code can be applied

setPageSize

List<R> setPageSize(int pageSize)

Changes the page size and returns the current page with a new page size.

Parameters:

pageSize - - new page size

Returns:

List of RESULT or empty list.

getTotalCount

int getTotalCount()

Returns count of all items in the collection that is being paged.

Returns:

total items count

getPageNumber

int getPageNumber()

Returns the active page number.

Returns:

the active page number

setPageNumber

void setPageNumber(int pageNo)

Sets the active page number.

getSortData

SortData getSortData()

Returns sort related information

Returns:

sort related information

setSortData

void setSortData(SortData sortData)

Parameters:

sortData - sort related information

getAllResults

List<R> getAllResults()

Returns all results on all pages. May be a long lasting operation for big data sets, therefore should be used carefully.

Returns:

setQueryId

default void setQueryId(String queryId)

Parameters:

queryId - Queries with same identifiers are assumed to perform same request to data source