de.hybris.platform.commercesearch.searchandizing.facet.reconfiguration

Interface FacetAdminService

All Known Subinterfaces:

SearchStateApplicableFacetAdminService

All Known Implementing Classes:

CategoryFacetAdminService, DefaultFacetAdminService, GlobalFacetAdminService

public interface FacetAdminService

This interface should implemented by services that are responsible for facet administration like do facet visible/invisible or move facet up/down. Each implemented method should recognize the facet search state (for example category search or keyword search)

Method Summary

Modifier and Type	Method and Description
void	moveFacetAbove(String movedFacetCode, String stationaryFacetCode, FacetSearchStateData facetSearchStateData) This method moves the given facet above the stationary facet for a given search state (for a keyword or category).
void	moveFacetBelow(String movedFacetCode, String stationaryFacetCode, FacetSearchStateData facetSearchStateData) This method moves the given facet below the stationary facet for a given search state (for a keyword or category).
boolean	toggleFacetVisibility(String toggledFacetCode, FacetSearchStateData facetSearchStateData) This method toggles facet visibility for a given search state (for a keyword or category).

Method Detail

toggleFacetVisibility

boolean toggleFacetVisibility(String toggledFacetCode,
                              FacetSearchStateData facetSearchStateData)

This method toggles facet visibility for a given search state (for a keyword or category).

Parameters:

toggledFacetCode - Facet code of facet that should be toggled.

facetSearchStateData - Facet search state data contains the current search state

Returns:

Toggled facet visibility.

moveFacetAbove

void moveFacetAbove(String movedFacetCode,
                    String stationaryFacetCode,
                    FacetSearchStateData facetSearchStateData)

This method moves the given facet above the stationary facet for a given search state (for a keyword or category).

Parameters:

movedFacetCode - Facet code of facet that should be moved above.

stationaryFacetCode - Facet code of stationary facet.

facetSearchStateData - Facet search state data contains the current search state

moveFacetBelow

void moveFacetBelow(String movedFacetCode,
                    String stationaryFacetCode,
                    FacetSearchStateData facetSearchStateData)

This method moves the given facet below the stationary facet for a given search state (for a keyword or category).

Parameters:

movedFacetCode - Facet code of facet that should be moved below.

stationaryFacetCode - Facet code of stationary facet.

facetSearchStateData - Facet search state data contains the current search state