Package org.ametys.plugins.calendar.search

Class CalendarContentReturnable

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.calendar.search.CalendarContentReturnable

All Implemented Interfaces:

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

public class CalendarContentReturnable
extends AbstractContentBasedReturnable

Returnable for contents with a start date

Field Summary

Fields

Modifier and Type	Field	Description
protected SourceResolver	_srcResolver	The source resolver
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
CalendarContentReturnable()

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.
SourceResolver	getSourceResolver()	Get the source resolver
TagProviderExtensionPoint	getTagProviderExtensionPoint()	Get the tag provider extension point
protected String	getViewForSax(AdditionalParameterValueMap additionalParameterValues)	Get the model view for sax
boolean	isPrivate()	Returns true if this returnable is private
void	service(ServiceManager smanager)

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

_setAssociatedContentSearchable, configure, contextualize, filterReturnedDocumentQuery, getContentHelper, getFacets, getLabel, getSorts, initialize, langQueryProducer, relationsWith, sitemapQueryJoiner, siteQueryJoiner, 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

_srcResolver

protected SourceResolver _srcResolver

The source resolver

Constructor Details

CalendarContentReturnable

public CalendarContentReturnable()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentBasedReturnable

Throws:

ServiceException

getId

public String getId()

Description copied from interface: Returnable

Gets the id of the extension

Returns:

the id of the extension

isPrivate

public boolean isPrivate()

Description copied from interface: Returnable

Returns true if this returnable is private

Returns:

true if this returnable is private

getSourceResolver

public SourceResolver getSourceResolver()

Get the source resolver

Returns:

the source resolver

getTagProviderExtensionPoint

public TagProviderExtensionPoint getTagProviderExtensionPoint()

Get the tag provider extension point

Returns:

the tag provider extension point

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.

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

getViewForSax

protected String getViewForSax(AdditionalParameterValueMap additionalParameterValues)

Get the model view for sax

Parameters:

additionalParameterValues - The additional parameter values

Returns:

the model view to use for saxing results

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

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