Package org.ametys.web.frontoffice.search.metamodel

Interface FacetDefinition

All Known Implementing Classes:

CommonPseudoContentTypeFacetDefinition, ContentFacetDefinition, PageContentFacetDefinition

public interface FacetDefinition

A potential facet proposed to the creator of an instance of search service.

Method Summary

Modifier and Type	Method	Description
Optional<I18nizableText>	getFacetLabel(String value, Map<String,Object> contextualParameters)	Gets the label of a facet value
String	getId()	Gets the id of the facet.
I18nizableText	getLabel()	Gets the label of the facet.
Optional<Returnable>	getReturnable()	Gets the (Returnable) the facet belongs to.
SearchField	getSearchField()	Gets the search field of this facet

Method Details

getId

String getId()

Gets the id of the facet. It must be unique across all facet definitions

Returns:

the unique id of the facet

getLabel

I18nizableText getLabel()

Gets the label of the facet.

Returns:

the label of the facet.

getSearchField

SearchField getSearchField()

Gets the search field of this facet

Returns:

the search field of this facet

getFacetLabel

Optional<I18nizableText> getFacetLabel(String value,
 Map<String,Object> contextualParameters)

Gets the label of a facet value

Parameters:

value - the facet value

contextualParameters - the contextual parameters

Returns:

the label of a facet value

getReturnable

Optional<Returnable> getReturnable()

Gets the (Returnable) the facet belongs to.

Returns:

the (Returnable) the facet belongs to.