Package org.ametys.cms.search.ui.model

Interface SearchUICriterion

All Superinterfaces:

Field, SearchCriterion

All Known Implementing Classes:

AbstractCustomSearchUICriterion, AbstractSearchUICriterion, ContentPrivacySearchUICriterion, DynamicWrappedSearchUIModel.WrappedSearchUICriterion, IndexingFieldAggregatorSearchUICriterion, IndexingFieldSearchUICriterion, PageSearchUICriterion, ProgramItemContextSearchUICriteria, ShareableCourseSearchUICriteria, SystemSearchUICriterion

public interface SearchUICriterion
extends SearchCriterion

This class represents a search criterion of a SearchModel

Method Summary

Modifier and Type	Method	Description
String	getChangeClassName()	Get the JS class name to execute on 'change' event
Object	getDefaultValue()	Retrieves the default value. If the criterion is hidden, this represents a fixed value for the criterion.
I18nizableText	getDescription()	Retrieves the description.
I18nizableText	getFacetLabel(String value, Locale currentLocale)	Get the label of a facet value.
String	getFieldId()	Get the field identifier.
I18nizableText	getGroup()	Get the group of the search criterion
String	getInitClassName()	Get the JS class name to execute on 'init' event
I18nizableText	getLabel()	Retrieves the label.
String	getSubmitClassName()	Get the JS class name to execute on 'submit' event
Validator	getValidator()	Retrieves the validator.
String	getWidget()	Retrieves the widget to use for rendering.
Map<String,I18nizableText>	getWidgetParameters()	Get the widget's parameters
boolean	isHidden()	Determines if the criterion is hidden

Methods inherited from interface org.ametys.cms.search.model.Field

getContentTypeId, getEnumerator, getType, isMultiple

Methods inherited from interface org.ametys.cms.search.model.SearchCriterion

getId, getOperator, getQuery, getQuery, getSearchField, isFacetable, isSortable

Method Detail

getLabel

I18nizableText getLabel()

Retrieves the label.

Returns:

the label.

getDescription

I18nizableText getDescription()

Retrieves the description.

Returns:

the description.

getFieldId

String getFieldId()

Get the field identifier. Used to match standard, advanced and faceted criterion (even if the operator is different), whatever their ID is.

Returns:

the field identifier.

getGroup

I18nizableText getGroup()

Get the group of the search criterion

Returns:

null if the search criterion does not belong to any group, the name of the group otherwise

getInitClassName

String getInitClassName()

Get the JS class name to execute on 'init' event

Returns:

the JS class name to execute on 'init' event

getSubmitClassName

String getSubmitClassName()

Get the JS class name to execute on 'submit' event

Returns:

the JS class name to execute on 'submit' event

getChangeClassName

String getChangeClassName()

Get the JS class name to execute on 'change' event

Returns:

the JS class name to execute on 'change' event

isHidden

boolean isHidden()

Determines if the criterion is hidden

Returns:

true if the criterion is hidden

getWidget

String getWidget()

Retrieves the widget to use for rendering.

Returns:

the widget or null if none is defined.

getWidgetParameters

Map<String,I18nizableText> getWidgetParameters()

Get the widget's parameters

Returns:

the widget's parameters

getValidator

Validator getValidator()

Retrieves the validator.

Returns:

the validator or null if none is defined.

getDefaultValue

Object getDefaultValue()

Retrieves the default value.
If the criterion is hidden, this represents a fixed value for the criterion.

Returns:

the default value or null if none is defined.

getFacetLabel

I18nizableText getFacetLabel(String value,
                             Locale currentLocale)

Get the label of a facet value.

Parameters:

value - the facet value.

currentLocale - the current locale

Returns:

the label, or null if the value does not exist.