Package org.ametys.web.search.model.impl

Class ContentPrivacyCriterionDefinition

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.DefaultElementDefinition<Boolean>

org.ametys.cms.search.model.impl.AbstractCriterionDefinition<Boolean>

org.ametys.cms.search.model.impl.DefaultSearchModelCriterionDefinition<Boolean>

org.ametys.cms.search.model.impl.AbstractStaticSearchModelCriterionDefinition<Boolean>

org.ametys.web.search.model.impl.ContentPrivacyCriterionDefinition

All Implemented Interfaces:

Comparable<ModelItem>, CriterionDefinition<Boolean>, SearchModelCriterionDefinition<Boolean>, ElementDefinition<Boolean>, ModelItem, Labelable, ModifiableLabelable, Component, Configurable, Contextualizable, Serviceable

public class ContentPrivacyCriterionDefinition
extends AbstractStaticSearchModelCriterionDefinition<Boolean>
implements Contextualizable

Custom boolean SearchModelCriterionDefinition representing whether to take content access restrictions ("content privacy") into account.
It's generally used as a hidden criterion to force the "true" or "false" value.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The avalon context
protected JSONUtils	_jsonUtils	The JSON utils.
protected String	_siteCriterionName	The site criterion ID.
protected SiteManager	_siteManager	The site manager.

Fields inherited from class org.ametys.cms.search.model.impl.AbstractStaticSearchModelCriterionDefinition

_criterionTypeExtensionPoint

Fields inherited from class org.ametys.cms.search.model.impl.DefaultSearchModelCriterionDefinition

_operator

Fields inherited from class org.ametys.cms.search.model.impl.AbstractCriterionDefinition

_criterionDefinitionHelper, _joinedPaths, _multipleOperandOperator, _solrFacetFieldName

Fields inherited from class org.ametys.runtime.model.DefaultElementDefinition

_logger

Fields inherited from class org.ametys.runtime.model.AbstractModelItem

__context, __serviceManager

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

Constructor Summary

Constructors

Constructor	Description
ContentPrivacyCriterionDefinition()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
void	contextualize(Context context)
Query.Operator	getOperator()	Get the criterion Operator.
Query	getQuery(Object value, Query.Operator customOperator, Map<String,Object> allValues, String language, Map<String,Object> contextualParameters)	Get the Query associated to the given value.
protected String	getTypeId()	Retrieves the id of the property's type
boolean	isMultiple()	Test if the element is multiple.
void	service(ServiceManager manager)
void	setSiteCriterionName(String siteCriterionName)	Set the site criterion name

Methods inherited from class org.ametys.cms.search.model.impl.AbstractStaticSearchModelCriterionDefinition

getType, setMultipleOperandOperator, setOperator

Methods inherited from class org.ametys.cms.search.model.impl.DefaultSearchModelCriterionDefinition

_getDefaultOperator, _toJSON, copyTo, getModel, toSAX

Methods inherited from class org.ametys.cms.search.model.impl.AbstractCriterionDefinition

_defaultValueToJSON, _getCriterionDefinitionHelper, _getDefaultWidget, _getDefaultWidgetParameters, convertQueryValue, getJoinedPaths, getMultipleOperandOperator, getQueryContext, getSolrFacetFieldName, getWidget, getWidgetParameters, setJoinedPaths, setSolrFacetFieldName

Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition

_getDefaultValues, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, of, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setType, setValidator, setValidatorConfiguration, setWidget, setWidgetParameters

Methods inherited from class org.ametys.runtime.model.AbstractModelItem

_getModelItemHelper, _shouldJSONBeEmpty, _widgetParameterToSAX, addItemChecker, compareTo, disableConditionsToJSON, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getName, getParent, getPath, getPluginName, hashCode, setContext, setDescription, setDisableConditions, setLabel, setModel, setName, setParent, setPluginName, setServiceManager, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

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

convertQueryValue, getJoinedPaths, getQuery, getQuery, getSolrFacetFieldName

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

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, isEditable, 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

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

setDescription, setLabel, setName

Field Details

_siteManager

protected SiteManager _siteManager

The site manager.

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils.

_context

protected Context _context

The avalon context

_siteCriterionName

protected String _siteCriterionName

The site criterion ID.

Constructor Details

ContentPrivacyCriterionDefinition

public ContentPrivacyCriterionDefinition()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractStaticSearchModelCriterionDefinition<Boolean>

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractStaticSearchModelCriterionDefinition<Boolean>

Throws:

ConfigurationException

getTypeId

protected String getTypeId()

Description copied from class: AbstractStaticSearchModelCriterionDefinition

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractStaticSearchModelCriterionDefinition<Boolean>

Returns:

the id of the property's type

isMultiple

public boolean isMultiple()

Description copied from interface: ElementDefinition

Test if the element is multiple.

Specified by:

isMultiple in interface ElementDefinition<Boolean>

Overrides:

isMultiple in class DefaultElementDefinition<Boolean>

Returns:

true if the metadata is multiple.

getOperator

public Query.Operator getOperator()

Description copied from interface: SearchModelCriterionDefinition

Get the criterion Operator.

Specified by:

getOperator in interface SearchModelCriterionDefinition<Boolean>

Overrides:

getOperator in class DefaultSearchModelCriterionDefinition<Boolean>

Returns:

the criterion Operator.

setSiteCriterionName

public void setSiteCriterionName(String siteCriterionName)

Set the site criterion name

Parameters:

siteCriterionName - the site criterion name to set

getQuery

public Query getQuery(Object value,
 Query.Operator customOperator,
 Map<String,Object> allValues,
 String language,
 Map<String,Object> contextualParameters)

Description copied from interface: CriterionDefinition

Get the Query associated to the given value.

Specified by:

getQuery in interface CriterionDefinition<Boolean>

Overrides:

getQuery in class DefaultSearchModelCriterionDefinition<Boolean>

Parameters:

value - The user-submitted value (or the default value if not set) for this criterion.

customOperator - In advanced search mode, the operator chosen by the user. null to use the criterion-defined operator (simple search mode).

allValues - All the user-submitted values.

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

Query associated to the given value.