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

Interface SearchServiceFacetDefinition

All Superinterfaces:

Labelable

All Known Implementing Classes:

CommonPseudoContentTypeFacetDefinition, ContentFacetDefinition, PageContentFacetDefinition

public interface SearchServiceFacetDefinition
extends Labelable

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

Method Summary

Modifier and Type	Method	Description
default I18nizableText	getContextPrefixLabel()	Gets the prefix label, sometimes useful (such as for displaying all criterion definitions) for grouping information.
SearcherFactory.FacetDefinition	getFacetDefinition()	Retrieves the facet definition
Optional<I18nizableText>	getFacetLabel(String value, Map<String,Object> contextualParameters)	Gets the label of a facet value
Optional<Returnable>	getReturnable()	Gets the (Returnable) the facet belongs to.

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel, getName

Method Details

getFacetDefinition

SearcherFactory.FacetDefinition getFacetDefinition()

Retrieves the facet definition

Returns:

the facet definition

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.

getContextPrefixLabel

default I18nizableText getContextPrefixLabel()

Gets the prefix label, sometimes useful (such as for displaying all criterion definitions) for grouping information.

Returns:

The prefix label (can be null)