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

Interface FacetedPageableSearchResults

All Superinterfaces:

PageableSearchResults, WidgetController

All Known Subinterfaces:

SearchCommandController<SC>

All Known Implementing Classes:

DefaultSearchCommandController

public interface FacetedPageableSearchResults
extends PageableSearchResults

Controller interface that exposes faceted results.

Method Summary

Modifier and Type	Method and Description
boolean	addFacetValue(CsSearchFacetValue facetValue) Add the specified facet value to the search filter and execute the search again.
java.util.Set<CsSearchFacetValue>	getAppliedFacets() Get the currently applied facet values.
java.util.Set<CsSearchFacet>	getAvailableFacets() Get the available facets that can be applied to the results.
boolean	removeFacetValue(CsSearchFacetValue facetValue) Remove the applied facet value from the search filter and execute teh search again.

Methods inherited from interface de.hybris.platform.cscockpit.widgets.controllers.search.PageableSearchResults

getAvailableSorts, getCurrentPageNumber, getCurrentPageResults, getCurrentSortOrder, getPageSize, getTotalPages, getTotalResultCount, setCurrentPageNumber, setCurrentSortOrder

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

addCockpitEventAcceptor, dispatchEvent, removeCockpitEventAcceptor, setCockpitEventAcceptors

Method Detail

getAvailableFacets

java.util.Set<CsSearchFacet> getAvailableFacets()

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

Returns:

the set of available facets

addFacetValue

boolean addFacetValue(CsSearchFacetValue facetValue)
               throws SearchException

Add the specified facet value to the search filter and execute the search again. Changing the facet filters will cause the search to the executed again. Once this call is complete the results can be retrieved by calling the PageableSearchResults.getCurrentPageResults() method.

Parameters:

facetValue - the facet value to add to the search filters

Returns:

true if the facet has been added

Throws:

SearchException - thrown if the search failed

getAppliedFacets

java.util.Set<CsSearchFacetValue> getAppliedFacets()

Get the currently applied facet values. These are the facet values that were used to filter the current results.

Returns:

the set of applied facet values.

removeFacetValue

boolean removeFacetValue(CsSearchFacetValue facetValue)
                  throws SearchException

Remove the applied facet value from the search filter and execute teh search again. Changing the facet filters will cause the search to the executed again. Once this call is complete the results can be retrieved by calling the PageableSearchResults.getCurrentPageResults() method.

Parameters:

facetValue - the facet value to remove

Returns:

true if the facet has been removed

Throws:

SearchException - thrown if the search failed