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

Class AbstractCsFacetSearchCommand

java.lang.Object

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

All Implemented Interfaces:

CsFacetSearchCommand, CsSearchCommand

Direct Known Subclasses:

DefaultCsTextFacetSearchCommand

public abstract class AbstractCsFacetSearchCommand
extends java.lang.Object
implements CsFacetSearchCommand

Constructor Summary

Constructors

Constructor and Description
AbstractCsFacetSearchCommand()

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCsFacetSearchCommand

public AbstractCsFacetSearchCommand()

Method Detail

getFacetValues

public java.util.Set<CsSearchFacetValue> getFacetValues()

Description copied from interface: CsFacetSearchCommand

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

Specified by:

getFacetValues in interface CsFacetSearchCommand

Returns:

the facet values

setFacetValues

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

Description copied from interface: CsFacetSearchCommand

Set applied facet values

Specified by:

setFacetValues in interface CsFacetSearchCommand

Parameters:

facetValues - the facet values

addFacet

public boolean addFacet(CsSearchFacetValue facetValue)

Description copied from interface: CsFacetSearchCommand

Add a facet value to the set of restrictions

Specified by:

addFacet in interface CsFacetSearchCommand

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

public boolean removeFacet(CsSearchFacetValue facetValue)

Description copied from interface: CsFacetSearchCommand

Remove a facet value from the set of restrictions

Specified by:

removeFacet in interface CsFacetSearchCommand

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

public CsSearchFacetValue getCurrentFacet()

Description copied from interface: CsFacetSearchCommand

Recently applied facet value

Specified by:

getCurrentFacet in interface CsFacetSearchCommand

Returns:

the facet value