Package org.ametys.odf.course.search

Class ShareableCourseSearchUICriteria

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.odf.course.search.ShareableCourseSearchUICriteria

All Implemented Interfaces:

Field, SearchCriterion, SearchUICriterion, LogEnabled, Disposable, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

ShareableCoursePartSearchUICriteria

public class ShareableCourseSearchUICriteria
extends AbstractCustomSearchUICriterion

UI criteria for shareable course

Field Summary

Fields

Modifier and Type	Field	Description
protected ODFHelper	_odfHelper	The ODF helper
protected AmetysObjectResolver	_resolver	The ametys object resolver.
protected ShareableCourseHelper	_shareableCourseHelper	The shareable course helper

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

_contentHelper, _contentTypeExtensionPoint, _context, _enumeratorManager, _logger, _manager

Constructor Summary

Constructors

Constructor	Description
ShareableCourseSearchUICriteria()

Method Summary

Modifier and Type	Method	Description
protected Query	_getFieldQuery(Set<String> values, String metadataName)	Get query for the shareable course field.
protected List<Query>	_getShareableFieldQueries(ProgramItem programItem)	Get query form each shareable field
protected Query	_getShareableQuery(Object value, Query.Operator customOperator, Map<String,Object> allValues, String language, Map<String,Object> contextualParameters)	Get the Query associated to shareable fields
protected Query	_getValidatedShareableCourseQuery()	Get the query to get only validated shareable course
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.
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, configure, configureEnumerator, configureEnumerator, configureLabelsAndGroup, configureUIProperties, configureValues, configureWidget, configureWidget, configureWidgetParameters, configureWidgetParameters, configureWidgetParameters, contextualize, dispose, getChangeClassName, getContentTypeId, getGroup, getInitClassName, getSearchField, getSubmitClassName, isHidden, isMultiple, setChangeClassName, setContentTypeId, setGroup, setHidden, setInitClassName, setLogger, 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.model.Field

getEnumerator

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

getDescription, getId, getLabel, getQuery, isFacetable, isSortable

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

getDefaultValue, getValidator, getWidget, getWidgetParameters

Field Details

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver.

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_shareableCourseHelper

protected ShareableCourseHelper _shareableCourseHelper

The shareable course helper

Constructor Details

ShareableCourseSearchUICriteria

public ShareableCourseSearchUICriteria()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSearchUICriterion

Throws:

ServiceException

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.

Returns:

the field identifier.

getOperator

public Query.Operator getOperator()

Description copied from interface: SearchCriterion

Get the criterion Operator.

Returns:

the criterion Operator.

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.

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.

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.

_getShareableQuery

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

Get the Query associated to shareable fields

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 shareable fields

_getValidatedShareableCourseQuery

protected Query _getValidatedShareableCourseQuery()

Get the query to get only validated shareable course

Returns:

the query

_getShareableFieldQueries

protected List<Query> _getShareableFieldQueries(ProgramItem programItem)

Get query form each shareable field

Parameters:

programItem - the program item

Returns:

the list of query

_getFieldQuery

protected Query _getFieldQuery(Set<String> values,
 String metadataName)

Get query for the shareable course field. Query is "not(field) or field = values"

Parameters:

values - the values

metadataName - the metadata name of the field

Returns:

the fitler query