Package org.ametys.web.frontoffice.search.instance.model

Class SearchServiceCriterion<T>

java.lang.Object

org.ametys.web.frontoffice.search.instance.model.SearchServiceCriterion<T>

Type Parameters:

T - Type of the criterion value

public class SearchServiceCriterion<T>
extends Object

A search service criterion, representing a criterion valued by the webmaster when creating its SearchServiceInstance, i.e. a filled line in the 'Criterion' page (third page) on the creation/edition dialog box of a search service.

Constructor Summary

Constructors

Constructor	Description
SearchServiceCriterion(String id, SearchServiceCriterionDefinition<T> criterionDefinition, String operator, SearchServiceCriterionMode mode, RestrictedEnumerator.RestrictedValues<T> restrictedValues, Object staticValue)	Creates a criterion for Front-Office search service

Method Summary

Modifier and Type	Method	Description
SearchServiceCriterionDefinition<T>	getCriterionDefinition()	Gets the definition of the criterion
SearchServiceCriterionMode	getMode()	Gets the mode
String	getName()	Gets the id of the criterion
String	getOperator()	Gets the operator (as string)
Optional<RestrictedEnumerator.RestrictedValues<T>>	getRestrictedValues()	Gets the restricted values.
Optional<Object>	getStaticValue()	Gets the static value.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchServiceCriterion

public SearchServiceCriterion(String id,
 SearchServiceCriterionDefinition<T> criterionDefinition,
 String operator,
 SearchServiceCriterionMode mode,
 RestrictedEnumerator.RestrictedValues<T> restrictedValues,
 Object staticValue)

Creates a criterion for Front-Office search service

Parameters:

id - the id of the criterion

criterionDefinition - the definition of the criterion

operator - the operator (as string)

mode - the mode

restrictedValues - the restricted values. Must be non-empty if mode is SearchServiceCriterionMode.RESTRICTED_USER_INPUT, must be empty otherwise.

staticValue - the static value. Must be non-empty if mode is SearchServiceCriterionMode.STATIC, must be empty otherwise.

Method Details

getName

public String getName()

Gets the id of the criterion

Returns:

the id of the criterion

getCriterionDefinition

public SearchServiceCriterionDefinition<T> getCriterionDefinition()

Gets the definition of the criterion

Returns:

the definition of the criterion

getOperator

public String getOperator()

Gets the operator (as string)

Returns:

the operator (as string)

getMode

public SearchServiceCriterionMode getMode()

Gets the mode

Returns:

the mode

getRestrictedValues

public Optional<RestrictedEnumerator.RestrictedValues<T>> getRestrictedValues()

Gets the restricted values. Must be non-empty if getMode() returns SearchServiceCriterionMode.RESTRICTED_USER_INPUT, must be empty otherwise.

Returns:

the restricted values

getStaticValue

public Optional<Object> getStaticValue()

Gets the static value. Must be non-empty if getMode() returns SearchServiceCriterionMode.STATIC, must be empty otherwise.

Returns:

the static value