de.hybris.platform.cscockpit.services.search

Interface CsFacetSearchCommand

All Superinterfaces:

CsSearchCommand

All Known Implementing Classes:

AbstractCsFacetSearchCommand, DefaultCsTextFacetSearchCommand

public interface CsFacetSearchCommand
extends CsSearchCommand

A search command that includes facet values in the search query. Facet values can be added to, or removed from the set of facet values in this command.

Method Summary

Modifier and Type	Method and Description
boolean	addFacet(CsSearchFacetValue facetValue) Add a facet value to the set of restrictions
CsSearchFacetValue	getCurrentFacet() Recently applied facet value
java.util.Set<CsSearchFacetValue>	getFacetValues() The set of facet values to apply as restrictions to this search command
boolean	removeFacet(CsSearchFacetValue facetValue) Remove a facet value from the set of restrictions
void	setFacetValues(java.util.Set<CsSearchFacetValue> facetValues) Set applied facet values

Method Detail

getFacetValues

java.util.Set<CsSearchFacetValue> getFacetValues()

The set of facet values to apply as restrictions to this search command

Returns:

the facet values

setFacetValues

void setFacetValues(java.util.Set<CsSearchFacetValue> facetValues)

Set applied facet values

Parameters:

facetValues - the facet values

addFacet

boolean addFacet(CsSearchFacetValue facetValue)

Add a facet value to the set of restrictions

Parameters:

facetValue - the facet value

Returns:

true if the facet value has been added to the restrictions, false if it was already in the restrictions

removeFacet

boolean removeFacet(CsSearchFacetValue facetValue)

Remove a facet value from the set of restrictions

Parameters:

facetValue - the facet value

Returns:

true if the facet value was removed from the restrictions, false if it was not found in the restrictions

getCurrentFacet

CsSearchFacetValue getCurrentFacet()

Recently applied facet value

Returns:

the facet value