de.hybris.platform.cscockpit.services.search

Interface CsSearchResult<SC extends CsSearchCommand,E>

Type Parameters:

SC - The type of search command used to run the search

E - The search result element type

All Known Subinterfaces:

CsFacetSearchResult<SC,E>

All Known Implementing Classes:

DefaultCsFacetSearchResult, DefaultCsSearchResult

public interface CsSearchResult<SC extends CsSearchCommand,E>

Interface to represent search results.

Method Summary

Modifier and Type	Method and Description
List<CsSort>	getAvailableSorts() The sorting options that are available for this search result.
Pageable	getPageable() The paging and sorting data requested for the search that generated these results
List<DataObject<E>>	getResult() The search result elements found.
SC	getSearchCommand() The search command used to generate the search results
int	getTotalPages() The total number of result pages.
long	getTotalResultCount() The total number of results matched by the search.

Method Detail

getSearchCommand

SC getSearchCommand()

The search command used to generate the search results

Returns:

the search command

getPageable

Pageable getPageable()

The paging and sorting data requested for the search that generated these results

Returns:

the paging and sorting data

getResult

List<DataObject<E>> getResult()

The search result elements found. Only the results for the requested page are included. Results are sorted in the requested sort order. Each element has additional search meta data associated with it.

Returns:

list of the elements found

getTotalResultCount

long getTotalResultCount()

The total number of results matched by the search. The results returned are limited by the requested page, this method returns the total number of results matched across all the result pages.

Returns:

the total number of results

getTotalPages

int getTotalPages()

The total number of result pages. The total number of pages required to display the total result count given the requested page size.

Returns:

the total number of result pages.

getAvailableSorts

List<CsSort> getAvailableSorts()

The sorting options that are available for this search result. The list of available sorts may change for each search.

Returns:

the list of sort options