de.hybris.platform.cscockpit.widgets.controllers.search

Interface PageableSearchResults

All Superinterfaces:

WidgetController

All Known Subinterfaces:

FacetedPageableSearchResults, SearchCommandController<SC>

All Known Implementing Classes:

DefaultSearchCommandController

public interface PageableSearchResults
extends WidgetController

Controller interface that exposes pageable results

Method Summary

Modifier and Type	Method and Description
java.util.List<CsSort>	getAvailableSorts() Get the available sorts that can be applied to the results.
int	getCurrentPageNumber() Get the current page number.
java.util.List<DataObject<TypedObject>>	getCurrentPageResults() Get the current page of results.
CsSort	getCurrentSortOrder() Get the currently applied sort order.
int	getPageSize() Get the page size or the number of results to return in each page.
int	getTotalPages() Get the total number of pages required to display the results of the search.
long	getTotalResultCount() Get the total number of results that match the search.
boolean	setCurrentPageNumber(int page) Change the current page to the specified page number.
boolean	setCurrentSortOrder(CsSort sort) Change the current sort to the specified sort.

Methods inherited from interface de.hybris.platform.cockpit.widgets.controllers.WidgetController

addCockpitEventAcceptor, dispatchEvent, removeCockpitEventAcceptor, setCockpitEventAcceptors

Method Detail

getCurrentPageResults

java.util.List<DataObject<TypedObject>> getCurrentPageResults()

Get the current page of results. Only the current page is available. The results are wrapped in DataObject instances that provide access to the TypedObject item as well as the meta data for the item.

Returns:

the list of results for the current page.

getCurrentPageNumber

int getCurrentPageNumber()

Get the current page number. The first page is page number zero.

Returns:

the current page number, zero for the first page.

setCurrentPageNumber

boolean setCurrentPageNumber(int page)
                      throws SearchException

Change the current page to the specified page number. The first page is page number zero. Changing the page will cause the search to be executed again to retrieve the required page. Once this call is complete the results can be retrieved by calling the getCurrentPageResults() method.

Parameters:

page - the page number, zero for the first page.

Returns:

true if the page has been changed

Throws:

SearchException - thrown if the search failed

getTotalResultCount

long getTotalResultCount()

Get the total number of results that match the search. This is the number of matches across all pages.

Returns:

the total number of results

getTotalPages

int getTotalPages()

Get the total number of pages required to display the results of the search.

Returns:

the total number of results

See Also:

getTotalResultCount(), getPageSize()

getPageSize

int getPageSize()

Get the page size or the number of results to return in each page.

Returns:

the page size

getCurrentSortOrder

CsSort getCurrentSortOrder()

Get the currently applied sort order.

Returns:

the sort order

getAvailableSorts

java.util.List<CsSort> getAvailableSorts()

Get the available sorts that can be applied to the results.

Returns:

the list of available sorts

setCurrentSortOrder

boolean setCurrentSortOrder(CsSort sort)
                     throws SearchException

Change the current sort to the specified sort. Changing the sort will cause the search to be executed again to re-order the results. Once this call is complete the results can be retrieved by calling the getCurrentPageResults() method.

Parameters:

sort - the new sort

Returns:

true if the sort has been changed

Throws:

SearchException - thrown if the search failed