Package org.ametys.plugins.odfweb.service.search

Class CourseReturnable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder

org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdderReturnable

org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable

org.ametys.plugins.odfweb.service.search.CourseReturnable

All Implemented Interfaces:

LogEnabled, PluginAware, Returnable, Initializable, Configurable, Contextualizable, Serviceable

public class CourseReturnable
extends AbstractContentBasedReturnable

Returnable for Courses

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	__PREFIX_ID	The prefix for the ids of sorts
protected ODFHelper	_odfHelper	THe ODF helper
protected OdfPageResolver	_odfPageResolver	The page resolver for ODF
protected URIResolver	_odfURIResolver	The URI resolver for ODF
protected ReturnableSaxer	_saxer	The saxer
static final String	ROLE	Avalon Role

Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable

_associatedContentSearchable, _contentFilterHelper, _contentHelper, _contentTypesHelper, _context, _label, _searchableEP

Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder

_manager, _pluginName

Constructor Summary

Constructors

Constructor	Description
CourseReturnable()

Method Summary

Modifier and Type	Method	Description
protected String	associatedContentSearchableRole()	The Avalon Role for the associated Content Searchable
protected Collection<String>	getContentTypes(AdditionalParameterValueMap additionalParameterValues)	Gets the content types which will be used to construct the query to filter the returned documents
protected String	getDefinitionPrefix()	Gets the prefix for definitions (for facets, sorts...)
String	getId()	Gets the id of the extension
ReturnableSaxer	getSaxer(Collection<Returnable> allReturnables, AdditionalParameterValueMap additionalParameterValues)	Returns the saxer responsible to SAX hits of this Returnable.
void	service(ServiceManager manager)
protected Function<Query,Query>	siteQueryJoiner()	The joiner for the site query

Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable

_setAssociatedContentSearchable, configure, contextualize, filterReturnedDocumentQuery, getFacets, getLabel, getSorts, initialize, langQueryProducer, relationsWith, sitemapQueryJoiner, tagQueryJoiner

Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder

additionalServiceParameters, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.web.frontoffice.search.metamodel.Returnable

additionalServiceParameters, selectedByDefault

Field Details

ROLE

public static final String ROLE

Avalon Role

__PREFIX_ID

protected static final String __PREFIX_ID

The prefix for the ids of sorts

See Also:

• Constant Field Values

_odfPageResolver

protected OdfPageResolver _odfPageResolver

The page resolver for ODF

_odfHelper

protected ODFHelper _odfHelper

THe ODF helper

_odfURIResolver

protected URIResolver _odfURIResolver

The URI resolver for ODF

_saxer

protected ReturnableSaxer _saxer

The saxer

Constructor Details

CourseReturnable

public CourseReturnable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentBasedReturnable

Throws:

ServiceException

associatedContentSearchableRole

protected String associatedContentSearchableRole()

Description copied from class: AbstractContentBasedReturnable

The Avalon Role for the associated Content Searchable

Specified by:

associatedContentSearchableRole in class AbstractContentBasedReturnable

Returns:

The Avalon Role for the associated Content Searchable

getId

public String getId()

Description copied from interface: Returnable

Gets the id of the extension

Returns:

the id of the extension

siteQueryJoiner

protected Function<Query,Query> siteQueryJoiner()

Description copied from class: AbstractContentBasedReturnable

The joiner for the site query

Overrides:

siteQueryJoiner in class AbstractContentBasedReturnable

Returns:

The joiner for the site query

getContentTypes

protected Collection<String> getContentTypes(AdditionalParameterValueMap additionalParameterValues)

Description copied from class: AbstractContentBasedReturnable

Gets the content types which will be used to construct the query to filter the returned documents

Specified by:

getContentTypes in class AbstractContentBasedReturnable

Parameters:

additionalParameterValues - The additional parameter values

Returns:

the content types which will be used to construct the query to filter the returned documents

getSaxer

public ReturnableSaxer getSaxer(Collection<Returnable> allReturnables,
 AdditionalParameterValueMap additionalParameterValues)

Description copied from interface: Returnable

Returns the saxer responsible to SAX hits of this Returnable.

Parameters:

allReturnables - All Returnables (including this)

additionalParameterValues - The additional parameter values

Returns:

the saxer responsible to SAX hits of this Returnable.

getDefinitionPrefix

protected String getDefinitionPrefix()

Description copied from class: AbstractContentBasedReturnable

Gets the prefix for definitions (for facets, sorts...)

Specified by:

getDefinitionPrefix in class AbstractContentBasedReturnable

Returns:

the prefix for definitions