com.hybris.backoffice.widgets.advancedsearch.engine

Class PageableWithFullTextDataCallback

java.lang.Object

com.hybris.backoffice.widgets.advancedsearch.engine.PageableWithFullTextDataCallback

All Implemented Interfaces:

IdentifiableSearchQuery, FullTextSearchPageable, Pageable

public abstract class PageableWithFullTextDataCallback
extends Object
implements FullTextSearchPageable

Pageable wrapper which calls onFullTextSearchData(FullTextSearchData) after current page is fetched and full text search data is available.

Method Summary

Modifier and Type	Method and Description
List	getAllResults() Returns all results on all pages.
List	getCurrentPage() Gets the entries of the current record.
FullTextSearchData	getFullTextSearchData() Gets full text search data.
Pageable	getPageable()
int	getPageNumber() Returns the active page number.
int	getPageSize() Returns the page size.
String	getQueryId()
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	nextPage() Gets the entries of the next record page and updates the current page number (see Pageable.getCurrentPage()).
List	previousPage() Get the entries of the previous page and updates the current page number (see Pageable.getCurrentPage()).
void	refresh() Refreshes current page.
void	setPageNumber(int pageNo) Sets the active page number.
List	setPageSize(int pageSize) Changes the page size and returns the current page with a new page size.
void	setQueryId(String queryId)
void	setSortData(SortData sortData)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCurrentPage

public List getCurrentPage()

Description copied from interface: Pageable

Gets the entries of the current record.

Specified by:

getCurrentPage in interface Pageable

Returns:

all entries of the current record page

getPageable

public Pageable getPageable()

refresh

public void refresh()

Description copied from interface: Pageable

Refreshes current page.

Specified by:

refresh in interface Pageable

nextPage

public List nextPage()

Description copied from interface: Pageable

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

Specified by:

nextPage in interface Pageable

Returns:

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

previousPage

public List previousPage()

Description copied from interface: Pageable

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

Specified by:

previousPage in interface Pageable

Returns:

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

hasNextPage

public boolean hasNextPage()

Description copied from interface: Pageable

Determines if there is a next page.

Specified by:

hasNextPage in interface Pageable

Returns:

boolean

hasPreviousPage

public boolean hasPreviousPage()

Description copied from interface: Pageable

Determines if there is a previous page.

Specified by:

hasPreviousPage in interface Pageable

Returns:

boolean

getPageSize

public int getPageSize()

Description copied from interface: Pageable

Returns the page size.

Specified by:

getPageSize in interface Pageable

Returns:

integer

getTypeCode

public String getTypeCode()

Description copied from interface: Pageable

Returns the "common" type code of all entries.

Specified by:

getTypeCode in interface Pageable

Returns:

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

setPageSize

public List setPageSize(int pageSize)

Description copied from interface: Pageable

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

Specified by:

setPageSize in interface Pageable

Parameters:

pageSize - - new page size

Returns:

List of RESULT or empty list.

getTotalCount

public int getTotalCount()

Description copied from interface: Pageable

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

Specified by:

getTotalCount in interface Pageable

Returns:

total items count

getPageNumber

public int getPageNumber()

Description copied from interface: Pageable

Returns the active page number.

Specified by:

getPageNumber in interface Pageable

Returns:

the active page number

setPageNumber

public void setPageNumber(int pageNo)

Description copied from interface: Pageable

Sets the active page number.

Specified by:

setPageNumber in interface Pageable

getSortData

public SortData getSortData()

Description copied from interface: Pageable

Returns sort related information

Specified by:

getSortData in interface Pageable

Returns:

sort related information

setSortData

public void setSortData(SortData sortData)

Specified by:

setSortData in interface Pageable

Parameters:

sortData - sort related information

getAllResults

public List getAllResults()

Description copied from interface: Pageable

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

Specified by:

getAllResults in interface Pageable

Returns:

getFullTextSearchData

public FullTextSearchData getFullTextSearchData()

Description copied from interface: FullTextSearchPageable

Gets full text search data.

Specified by:

getFullTextSearchData in interface FullTextSearchPageable

Returns:

full text search data.

getQueryId

public String getQueryId()

Specified by:

getQueryId in interface IdentifiableSearchQuery

Returns:

identifier of a query. Queries with same identifiers are assumed to perform same request to data source

setQueryId

public void setQueryId(String queryId)

Specified by:

setQueryId in interface Pageable

Parameters:

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