Package org.ametys.web.frontoffice.search.instance

Class SearchServiceInstanceManager

java.lang.Object

org.ametys.web.frontoffice.search.instance.SearchServiceInstanceManager

All Implemented Interfaces:

Disposable, Component, Serviceable

public class SearchServiceInstanceManager
extends Object
implements Component, Serviceable, Disposable

The component managing all SearchServiceInstances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
SearchServiceInstanceManager()

Method Summary

Modifier and Type	Method	Description
void	dispose()
SearchServiceInstance	get(String zoneItemId)	Gets, or creates if it does not exist yet, the SearchServiceInstance which is placed at the given ZoneItem.
boolean	isSearchServiceInstance(String zoneItemId)	Returns true if the given id of a ZoneItem is an instance of a SearchService
void	remove(String zoneItemId)	Removes the SearchServiceInstance which is placed at the given ZoneItem.
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon Role

Constructor Details

SearchServiceInstanceManager

public SearchServiceInstanceManager()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

isSearchServiceInstance

public boolean isSearchServiceInstance(String zoneItemId)

Returns true if the given id of a ZoneItem is an instance of a SearchService

Parameters:

zoneItemId - the id of the ZoneItem

Returns:

true if the given id of a ZoneItem is an instance of a SearchService

get

public SearchServiceInstance get(String zoneItemId)

Gets, or creates if it does not exist yet, the SearchServiceInstance which is placed at the given ZoneItem.
You must call isSearchServiceInstance before to ensure that the given id is an instance of SearchService (this check is not done in this method)

Parameters:

zoneItemId - the id of the ZoneItem

Returns:

the SearchServiceInstance which is placed at the given ZoneItem

remove

public void remove(String zoneItemId)

Removes the SearchServiceInstance which is placed at the given ZoneItem.

Parameters:

zoneItemId - the id of the ZoneItem