Package org.ametys.plugins.workspaces.search

Class StaticSearchModule

java.lang.Object

org.ametys.plugins.workspaces.search.StaticSearchModule

All Implemented Interfaces:

SearchModule, PluginAware, Configurable

public class StaticSearchModule
extends Object
implements SearchModule, Configurable, PluginAware

Static implementation of a SearchModule

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_featureName	The feature name
private String	_id
private int	_limit
private int	_minLimit
private int	_order
protected String	_pluginName	The plugin name
private String	_searchUrl
private I18nizableText	_title

Constructor Summary

Constructors

Constructor	Description
StaticSearchModule()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
String	getId()	Get the id
int	getLimit()	Get the number of results per page
int	getMinLimit()	Get the number of results per page on the main page (should be smaller than SearchModule.getLimit())
int	getOrder()	Get the module order, smaller order means that it is displayed before
String	getSearchUrl()	Get the search url
I18nizableText	getTitle()	Get the title of the search
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 java.lang.Object

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

Field Detail

_pluginName

protected String _pluginName

The plugin name

_featureName

protected String _featureName

The feature name

_id

private String _id

_title

private I18nizableText _title

_searchUrl

private String _searchUrl

_limit

private int _limit

_minLimit

private int _minLimit

_order

private int _order

Constructor Detail

StaticSearchModule

public StaticSearchModule()

Method Detail

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

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: SearchModule

Get the id

Specified by:

getId in interface SearchModule

Returns:

the id

getTitle

public I18nizableText getTitle()

Description copied from interface: SearchModule

Get the title of the search

Specified by:

getTitle in interface SearchModule

Returns:

title of the module

getSearchUrl

public String getSearchUrl()

Description copied from interface: SearchModule

Get the search url

Specified by:

getSearchUrl in interface SearchModule

Returns:

URL to fetch for search

getLimit

public int getLimit()

Description copied from interface: SearchModule

Get the number of results per page

Specified by:

getLimit in interface SearchModule

Returns:

Max number of results on the module view

getMinLimit

public int getMinLimit()

Description copied from interface: SearchModule

Get the number of results per page on the main page (should be smaller than SearchModule.getLimit())

Specified by:

getMinLimit in interface SearchModule

Returns:

Max number of results on the main view

getOrder

public int getOrder()

Description copied from interface: SearchModule

Get the module order, smaller order means that it is displayed before

Specified by:

getOrder in interface SearchModule

Returns:

The module order value