de.hybris.platform.cscockpit.services.search.impl

Class DefaultCsSearchResult<SC extends CsSearchCommand,E>

java.lang.Object

de.hybris.platform.cscockpit.services.search.impl.DefaultCsSearchResult<SC,E>

All Implemented Interfaces:

CsSearchResult<SC,E>

Direct Known Subclasses:

DefaultCsFacetSearchResult

public class DefaultCsSearchResult<SC extends CsSearchCommand,E>
extends java.lang.Object
implements CsSearchResult<SC,E>

Constructor Summary

Constructors

Constructor and Description
DefaultCsSearchResult()

Method Summary

Modifier and Type	Method and Description
java.util.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
java.util.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.
void	setAvailableSorts(java.util.List<CsSort> availableSorts)
void	setPageable(Pageable pageable)
void	setResult(java.util.List<DataObject<E>> result)
void	setSearchCommand(SC searchCommand)
void	setTotalResultCount(long totalResultCount)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCsSearchResult

public DefaultCsSearchResult()

Method Detail

getSearchCommand

public SC getSearchCommand()

Description copied from interface: CsSearchResult

The search command used to generate the search results

Specified by:

getSearchCommand in interface CsSearchResult<SC extends CsSearchCommand,E>

Returns:

the search command

setSearchCommand

public void setSearchCommand(SC searchCommand)

getPageable

public Pageable getPageable()

Description copied from interface: CsSearchResult

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

Specified by:

getPageable in interface CsSearchResult<SC extends CsSearchCommand,E>

Returns:

the paging and sorting data

setPageable

public void setPageable(Pageable pageable)

getResult

public java.util.List<DataObject<E>> getResult()

Description copied from interface: CsSearchResult

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.

Specified by:

getResult in interface CsSearchResult<SC extends CsSearchCommand,E>

Returns:

list of the elements found

setResult

public void setResult(java.util.List<DataObject<E>> result)

getTotalResultCount

public long getTotalResultCount()

Description copied from interface: CsSearchResult

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.

Specified by:

getTotalResultCount in interface CsSearchResult<SC extends CsSearchCommand,E>

Returns:

the total number of results

setTotalResultCount

public void setTotalResultCount(long totalResultCount)

getAvailableSorts

public java.util.List<CsSort> getAvailableSorts()

Description copied from interface: CsSearchResult

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

Specified by:

getAvailableSorts in interface CsSearchResult<SC extends CsSearchCommand,E>

Returns:

the list of sort options

setAvailableSorts

public void setAvailableSorts(java.util.List<CsSort> availableSorts)

getTotalPages

public int getTotalPages()

Description copied from interface: CsSearchResult

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

Specified by:

getTotalPages in interface CsSearchResult<SC extends CsSearchCommand,E>

Returns:

the total number of result pages.