Class ContentReturnable
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.web.frontoffice.search.metamodel.impl.ContentReturnable
- All Implemented Interfaces:
LogEnabled
,PluginAware
,Returnable
,Initializable
,Configurable
,Contextualizable
,Serviceable
Returnable
for Content
s-
Field Summary
Modifier and TypeFieldDescriptionprotected static final String
The prefix for the ids of facets and sortsstatic final String
The additional parameter for the viewstatic final String
Avalon RoleFields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable
_associatedContentSearchable, _contentFilterHelper, _contentHelper, _context, _label, _searchableEP
Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder
_manager, _pluginName
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected String
The Avalon Role for the associated Content Searchableprotected Collection<String>
getContentTypes
(AdditionalParameterValueMap additionalParameterValues) Gets the content types which will be used to construct the query to filter the returned documentsprotected String
Gets the prefix for definitions (for facets, sorts...)getId()
Gets the id of the extensiongetSaxer
(Collection<Returnable> allReturnables, AdditionalParameterValueMap additionalParameterValues) Returns thesaxer
responsible to SAX hits of this Returnable.protected String
getViewForSax
(AdditionalParameterValueMap additionalParameterValues) Gets the view for saxingMethods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable
_setAssociatedContentSearchable, configure, contextualize, filterReturnedDocumentQuery, getFacets, getLabel, getSorts, initialize, langQueryProducer, relationsWith, service, 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
Avalon Role -
PARAMETER_VIEW
The additional parameter for the view- See Also:
-
__PREFIX_ID
The prefix for the ids of facets and sorts- See Also:
-
-
Constructor Details
-
ContentReturnable
public ContentReturnable()
-
-
Method Details
-
associatedContentSearchableRole
Description copied from class:AbstractContentBasedReturnable
The Avalon Role for the associated Content Searchable- Specified by:
associatedContentSearchableRole
in classAbstractContentBasedReturnable
- Returns:
- The Avalon Role for the associated Content Searchable
-
getId
Description copied from interface:Returnable
Gets the id of the extension- Returns:
- the id of the extension
-
getContentTypes
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 classAbstractContentBasedReturnable
- 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 thesaxer
responsible to SAX hits of this Returnable.- Parameters:
allReturnables
- AllReturnable
s (including this)additionalParameterValues
- The additional parameter values- Returns:
- the
saxer
responsible to SAX hits of this Returnable.
-
getViewForSax
Gets the view for saxing- Parameters:
additionalParameterValues
- The additional parameter values- Returns:
- the view for saxing
-
getDefinitionPrefix
Description copied from class:AbstractContentBasedReturnable
Gets the prefix for definitions (for facets, sorts...)- Specified by:
getDefinitionPrefix
in classAbstractContentBasedReturnable
- Returns:
- the prefix for definitions
-