Package org.ametys.cms.search.model

Interface SearchModelCriterionDefinition<T>

Type Parameters:

T - Type of the criterion value

All Superinterfaces:

Comparable<ModelItem>, CriterionDefinition<T>, ElementDefinition<T>, Labelable, ModelItem, ModifiableLabelable

All Known Subinterfaces:

ContentTypesAwareCriterionDefinition, LanguageAwareCriterionDefinition

All Known Implementing Classes:

AbstractStaticSearchModelCriterionDefinition, CompatibleRegimesCriterionDefinition, ContentPrivacyCriterionDefinition, ContentReferencingSearchModelCriterionDefinition, ContentSearchModelCriterionDefinition, ContentTypesAwareReferencingCriterionDefinition, DefaultSearchModelCriterionDefinition, LanguageAwareReferencingCriterionDefinition, ODFContributorOrManagerCriterionDefinition, PageCriterionDefinition, ProgramItemContextCriterionDefinition, ReferencingAggregatorCriterionDefinition, ReferencingSearchModelCriterionDefinition, ShareableCourseCriterionDefinition, ShareableCoursePartCriterionDefinition, SolrFilterCriterionDefinition, StaticContentReferencingSearchModelCriterionDefinition, StaticContentTypesAwareReferencingCriterionDefinition, StaticLanguageAwareReferencingCriterionDefinition, StaticReferencingSearchModelCriterionDefinition, StaticSolrFilterCriterionDefinition

public interface SearchModelCriterionDefinition<T>
extends CriterionDefinition<T>

Represents the definition of a criterion definition of a SearchModel

Field Summary

Fields inherited from interface org.ametys.runtime.model.ElementDefinition

CONFIG_DEFAULT_VALUE_TYPE

Fields inherited from interface org.ametys.runtime.model.ModelItem

ITEM_PATH_SEPARATOR

Method Summary

Modifier and Type	Method	Description
void	copyTo(SearchModelCriterionDefinition<T> criterion, Map<String,Object> contextualParameters)	Copy the current criterion definition in the given one.
SearchModel	getModel()	Retrieves the model of the item
Query.Operator	getOperator()	Get the criterion Operator.
void	setMultipleOperandOperator(Query.LogicalOperator multipleOperandOperator)	Set the the logical operator for multi-valued criteria
void	setOperator(Query.Operator operator)	Set the criterion Operator.

Methods inherited from interface java.lang.Comparable

compareTo

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

convertQueryValue, getJoinedPaths, getQuery, getQuery, getQuery, getSolrFacetFieldName, getType

Methods inherited from interface org.ametys.runtime.model.ElementDefinition

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, isEditable, isMultiple, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setValidator, setValidatorConfiguration

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

getDescription, getLabel, getName

Methods inherited from interface org.ametys.runtime.model.ModelItem

addItemChecker, getDisableConditions, getItemCheckers, getParent, getPath, getPluginName, getWidget, getWidgetParameters, setDisableConditions, setModel, setParent, setPluginName, setType, setWidget, setWidgetParameters, toJSON, toSAX

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

setDescription, setLabel, setName

Method Details

getOperator

Query.Operator getOperator()

Get the criterion Operator.

Returns:

the criterion Operator.

setOperator

void setOperator(Query.Operator operator)

Set the criterion Operator.

Parameters:

operator - the Operator to set.

setMultipleOperandOperator

void setMultipleOperandOperator(Query.LogicalOperator multipleOperandOperator)

Set the the logical operator for multi-valued criteria

Parameters:

multipleOperandOperator - the logical operator to set

copyTo

void copyTo(SearchModelCriterionDefinition<T> criterion,
 Map<String,Object> contextualParameters)

Copy the current criterion definition in the given one.

Parameters:

criterion - the copy

contextualParameters - the contextual parameters

getModel

SearchModel getModel()

Description copied from interface: ModelItem

Retrieves the model of the item

Specified by:

getModel in interface ModelItem

Returns:

the model