Class PrivateContentReturnable
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.PrivateContentReturnable
- All Implemented Interfaces:
LogEnabled
,PluginAware
,Returnable
,Initializable
,Configurable
,Contextualizable
,Serviceable
- Direct Known Subclasses:
UserReturnable
This class is a generic returnable to be used to search on a
You must associate it with a
private
ContentType
.
You must associate it with a
Searchable
which is or extends PrivateContentSearchable
<extension point="org.ametys.web.frontoffice.search.metamodel.ReturnableExtensionPoint" id="my.returnable.id" class="org.ametys.web.frontoffice.search.metamodel.impl.PrivateContentReturnable"> <label i18n="true">...</label> <associatedSearchable>my.searchable.id</associatedSearchable> </extension>
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
The associated content searchable roleprotected String
The Avalon role of this Returnableprotected String
Theprefix
for facet and sort definitionsprotected String
The "short version" of the Avalon role of this ReturnableFields 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 void
_configureAssociatedContentReturnableRole
(Configuration configuration) Initializes_associatedContentSearchableRole
field from configurationprotected PrivateContentSearchable
Gets the associatedPrivateContentSearchable
protected void
_initAvalonRole
(Configuration configuration) Initializes_avalonRole
field from configurationprotected void
Initializes_definitionPrefix
fieldprotected void
Initializes_shortAvalonRole
fieldprotected String
The Avalon Role for the associated Content Searchablevoid
configure
(Configuration configuration) protected 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, 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
-
_avalonRole
The Avalon role of this Returnable -
_shortAvalonRole
The "short version" of the Avalon role of this Returnable -
_associatedContentSearchableRole
The associated content searchable role -
_definitionPrefix
Theprefix
for facet and sort definitions
-
-
Constructor Details
-
PrivateContentReturnable
public PrivateContentReturnable()
-
-
Method Details
-
configure
- Specified by:
configure
in interfaceConfigurable
- Overrides:
configure
in classAbstractContentBasedReturnable
- Throws:
ConfigurationException
-
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
-
_getAssociatedSearchable
Gets the associatedPrivateContentSearchable
- Returns:
- the associated
PrivateContentSearchable
-
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
-
_initAvalonRole
Initializes_avalonRole
field from configuration- Parameters:
configuration
- The configuration- Throws:
ConfigurationException
- If a configuration value cannot be retrieved
-
_initShortAvalonRole
Initializes_shortAvalonRole
field -
_configureAssociatedContentReturnableRole
protected void _configureAssociatedContentReturnableRole(Configuration configuration) throws ConfigurationException Initializes_associatedContentSearchableRole
field from configuration- Parameters:
configuration
- The configuration- Throws:
ConfigurationException
- If a configuration value cannot be retrieved
-
_initDefinitionPrefix
Initializes_definitionPrefix
field
-