org.ametys.web.search.model.impl

Class ContentPrivacySearchUICriterion

java.lang.Object

org.ametys.runtime.parameter.Parameter<MetadataType>

org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

org.ametys.cms.search.ui.model.impl.AbstractCustomSearchUICriterion

org.ametys.web.search.model.impl.ContentPrivacySearchUICriterion

All Implemented Interfaces:

Field, SearchCriterion, SearchUICriterion, Configurable, Contextualizable, Serviceable

public class ContentPrivacySearchUICriterion
extends AbstractCustomSearchUICriterion
implements Contextualizable

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

Field Summary

Fields

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

Fields inherited from class org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

_contentHelper, _cTypeEP, _resolver, _userManager, _userPopulationDAO

Constructor Summary

Constructors

Constructor and Description
ContentPrivacySearchUICriterion()

Method Summary

Modifier and Type	Method and Description
void	configure(Configuration configuration)
void	contextualize(Context context)
String	getFieldId() Get the field identifier.
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.
MetadataType	getType() Retrieves the type.
boolean	isMultiple() Determines if the column value is multiple
boolean	isSortable() Test if the SearchCriterion is sortable.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.search.ui.model.impl.AbstractCustomSearchUICriterion

configureId

Methods inherited from class org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

_configureI18nizableText, _initializeValidator, configureLabelsAndGroup, configureUIProperties, configureValues, configureWidget, configureWidgetParameters, getChangeClassName, getContentTypeId, getFacetLabel, getGroup, getInitClassName, getMetadataDefinition, getSearchField, getSubmitClassName, isHidden, setChangeClassName, setContentTypeId, setGroup, setHidden, setInitClassName, setMultiple, setSubmitClassName

Methods inherited from class org.ametys.runtime.parameter.Parameter

getDefaultValue, getDescription, getEnumerator, getId, getLabel, getPluginName, getValidator, getWidget, getWidgetParameters, setDefaultValue, setDescription, setEnumerator, setId, setLabel, setPluginName, setType, setValidator, setWidget, setWidgetParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.cms.search.ui.model.SearchUICriterion

getDefaultValue, getDescription, getLabel, getValidator, getWidget, getWidgetParameters

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

getId, getQuery, isFacetable, isFacetable, isSortable

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

getEnumerator

Field Detail

_siteManager

protected SiteManager _siteManager

The site manager.

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils.

_context

protected Context _context

The context.

_siteCriterionId

protected String _siteCriterionId

The site criterion ID.

Constructor Detail

ContentPrivacySearchUICriterion

public ContentPrivacySearchUICriterion()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSearchUICriterion

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractSearchUICriterion

Throws:

ConfigurationException

getType

public MetadataType getType()

Description copied from class: Parameter

Retrieves the type.

Specified by:

getType in interface Field

Overrides:

getType in class Parameter<MetadataType>

Returns:

the type.

isMultiple

public boolean isMultiple()

Description copied from class: AbstractSearchUICriterion

Determines if the column value is multiple

Specified by:

isMultiple in interface Field

Overrides:

isMultiple in class AbstractSearchUICriterion

Returns:

true if the value is multiple

isSortable

public boolean isSortable()

Description copied from interface: SearchCriterion

Test if the SearchCriterion is sortable.

Specified by:

isSortable in interface SearchCriterion

Returns:

true if the criterion is sortable, false otherwise.

getOperator

public Query.Operator getOperator()

Description copied from interface: SearchCriterion

Get the criterion Operator.

Specified by:

getOperator in interface SearchCriterion

Returns:

the criterion Operator.

getFieldId

public String getFieldId()

Description copied from interface: SearchUICriterion

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

Specified by:

getFieldId in interface SearchUICriterion

Returns:

the field identifier.

getQuery

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

Description copied from interface: SearchCriterion

Get the Query associated to the given value.

Specified by:

getQuery in interface SearchCriterion

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.