Package org.ametys.odf.course.search

Class ShareableCourseCriterionDefinition

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

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

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

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

org.ametys.odf.course.search.ShareableCourseCriterionDefinition

All Implemented Interfaces:

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

Direct Known Subclasses:

ShareableCoursePartCriterionDefinition

public class ShareableCourseCriterionDefinition
extends AbstractStaticSearchModelCriterionDefinition<String>

Search criterion 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.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
ShareableCourseCriterionDefinition()

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
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
void	service(ServiceManager manager)

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

configure, 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, isMultiple, 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, 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

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

setDescription, setLabel, setName

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

ShareableCourseCriterionDefinition

public ShareableCourseCriterionDefinition()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractStaticSearchModelCriterionDefinition<String>

Throws:

ServiceException

getOperator

public Query.Operator getOperator()

Description copied from interface: SearchModelCriterionDefinition

Get the criterion Operator.

Specified by:

getOperator in interface SearchModelCriterionDefinition<String>

Overrides:

getOperator in class DefaultSearchModelCriterionDefinition<String>

Returns:

the criterion Operator.

getTypeId

protected String getTypeId()

Description copied from class: AbstractStaticSearchModelCriterionDefinition

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractStaticSearchModelCriterionDefinition<String>

Returns:

the id of the property's type

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<String>

Overrides:

getQuery in class DefaultSearchModelCriterionDefinition<String>

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