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

Class FOSearchCriterion

java.lang.Object

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

public class FOSearchCriterion
extends Object

A FO search 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.

Field Summary

Fields

Modifier and Type	Field	Description
private SearchCriterionDefinition	_criterionDefinition
private String	_id
private FOSearchCriterionMode	_mode
private String	_operator
private EnumeratedValues.RestrictedValues	_restrictedValues
private Object	_staticValue

Constructor Summary

Constructors

Constructor	Description
FOSearchCriterion(String id, SearchCriterionDefinition criterionDefinition, String operator, FOSearchCriterionMode mode, EnumeratedValues.RestrictedValues restrictedValues, Object staticValue)	Creates a SearchCriterion for Front-Office search service

Method Summary

Modifier and Type	Method	Description
SearchCriterionDefinition	getCriterionDefinition()	Gets the definition of the criterion
String	getId()	Gets the id of the criterion
FOSearchCriterionMode	getMode()	Gets the mode
String	getOperator()	Gets the operator (as string)
Optional<EnumeratedValues.RestrictedValues>	getRestrictedValues()	Gets the restricted values.
Optional<Object>	getStaticValue()	Gets the static value.
boolean	isMandatory()	True if the criterion is linked to mandatory data

Methods inherited from class java.lang.Object

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

Field Detail

_id

private String _id

_criterionDefinition

private SearchCriterionDefinition _criterionDefinition

_operator

private String _operator

_mode

private FOSearchCriterionMode _mode

_restrictedValues

private EnumeratedValues.RestrictedValues _restrictedValues

_staticValue

private Object _staticValue

Constructor Detail

FOSearchCriterion

public FOSearchCriterion(String id,
                         SearchCriterionDefinition criterionDefinition,
                         String operator,
                         FOSearchCriterionMode mode,
                         EnumeratedValues.RestrictedValues restrictedValues,
                         Object staticValue)

Creates a SearchCriterion 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 FOSearchCriterionMode.RESTRICTED_USER_INPUT, must be empty otherwise.

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

Method Detail

getId

public String getId()

Gets the id of the criterion

Returns:

the id of the criterion

getCriterionDefinition

public SearchCriterionDefinition 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 FOSearchCriterionMode getMode()

Gets the mode

Returns:

the mode

getRestrictedValues

public Optional<EnumeratedValues.RestrictedValues> getRestrictedValues()

Gets the restricted values. Must be non-empty if getMode() returns FOSearchCriterionMode.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 FOSearchCriterionMode.STATIC, must be empty otherwise.

Returns:

the static value

isMandatory

public boolean isMandatory()

True if the criterion is linked to mandatory data

Returns:

true if the criterion is linked to mandatory data