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

Class AbstractParameterAdder

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

All Implemented Interfaces:

LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

AbstractParameterAdderReturnable, AbstractParameterAdderSearchable

public abstract class AbstractParameterAdder
extends AbstractLogEnabled
implements Configurable, Serviceable, PluginAware

Returnable or Searchable which adds some parameters to the search service.
Declared this way:

 <extension point="org.ametys.web.frontoffice.search.metamodel.Returnable/SearchableExtensionPoint"
         id="..."
         class="...">
     <parameters>
         <parameter name="..." reloadCriteriaOnChange="true">
             ...
         </parameter>
     </parameters>
 </extension>
 

Field Summary

Fields

Modifier and Type	Field and Description
private Configuration[]	_additionalParameterConfigs
protected ServiceManager	_manager The service manager
protected String	_pluginName The plugin of the extension

Constructor Summary

Constructors

Constructor and Description
AbstractParameterAdder()

Method Summary

Modifier and Type	Method and Description
Collection<Configuration>	additionalServiceParameters() Retrieves the additional parameters to add to the search service The ids of the parameters must be unique across all Returnables and Searchables Implementation for Searchable.additionalServiceParameters() and Returnable.additionalServiceParameters()
void	configure(Configuration configuration)
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id) Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

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

Field Detail

_manager

protected ServiceManager _manager

The service manager

_pluginName

protected String _pluginName

The plugin of the extension

_additionalParameterConfigs

private Configuration[] _additionalParameterConfigs

Constructor Detail

AbstractParameterAdder

public AbstractParameterAdder()

Method Detail

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

additionalServiceParameters

public Collection<Configuration> additionalServiceParameters()

Retrieves the additional parameters to add to the search service
The ids of the parameters must be unique across all Returnables and Searchables
Implementation for Searchable.additionalServiceParameters() and Returnable.additionalServiceParameters()

Returns:

some additional parameters to add to the search service