Package org.ametys.plugins.forms.search.facet

Class FormEntryFacetDefinition

java.lang.Object

org.ametys.plugins.forms.search.facet.FormEntryFacetDefinition

All Implemented Interfaces:

Labelable, SearchServiceFacetDefinition

public class FormEntryFacetDefinition
extends Object
implements SearchServiceFacetDefinition

Facet definition for a form entry

Constructor Summary

Constructors

Constructor	Description
FormEntryFacetDefinition(AbstractFormEntrySearchCriterionDefinition criterionDefinition)	The constructor of the facet definition for a form question

Method Summary

Modifier and Type	Method	Description
I18nizableText	getDescription()	Retrieves the description.
SearcherFactory.FacetDefinition	getFacetDefinition()	Retrieves the facet definition
Optional<I18nizableText>	getFacetLabel(String value, Map<String,Object> contextualParameters)	Gets the label of a facet value
I18nizableText	getLabel()	Retrieves the label.
String	getName()	Get the name.
Optional<Returnable>	getReturnable()	Gets the (Returnable) the facet belongs to.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.web.frontoffice.search.metamodel.SearchServiceFacetDefinition

getContextPrefixLabel

Constructor Details

FormEntryFacetDefinition

public FormEntryFacetDefinition(AbstractFormEntrySearchCriterionDefinition criterionDefinition)

The constructor of the facet definition for a form question

Parameters:

criterionDefinition - the criterion definition associated to the form entry

Method Details

getName

public String getName()

Description copied from interface: Labelable

Get the name.

Specified by:

getName in interface Labelable

Returns:

the name.

getLabel

public I18nizableText getLabel()

Description copied from interface: Labelable

Retrieves the label.

Specified by:

getLabel in interface Labelable

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: Labelable

Retrieves the description.

Specified by:

getDescription in interface Labelable

Returns:

the description.

getFacetDefinition

public SearcherFactory.FacetDefinition getFacetDefinition()

Description copied from interface: SearchServiceFacetDefinition

Retrieves the facet definition

Specified by:

getFacetDefinition in interface SearchServiceFacetDefinition

Returns:

the facet definition

getFacetLabel

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

Description copied from interface: SearchServiceFacetDefinition

Gets the label of a facet value

Specified by:

getFacetLabel in interface SearchServiceFacetDefinition

Parameters:

value - the facet value

contextualParameters - the contextual parameters

Returns:

the label of a facet value

getReturnable

public Optional<Returnable> getReturnable()

Description copied from interface: SearchServiceFacetDefinition

Gets the (Returnable) the facet belongs to.

Specified by:

getReturnable in interface SearchServiceFacetDefinition

Returns:

the (Returnable) the facet belongs to.