com.jivesoftware.community.search.opensearch
Interface SearchEngineManager

All Superinterfaces:

JiveManager

public interface SearchEngineManager
extends JiveManager

The SearchEngineManager is in charge of registering and managing the persistence of SearchEngines.

See Also:

SearchEngineManager

Method Summary

void	addSearchEngine(SearchEngine searchEngine) Add a search engine to be managed.
SearchEngine	addSearchEngineFromDescriptorURL(java.lang.String URL) Add a search engine to be managed.
SearchEngine	getSearchEngineByID(long searchEngineID) Find a managed search engine by its ID.
java.util.Collection<SearchEngine>	getSearchEngines() Get a List of all managed search engines.
SearchEngineManagerStats	getStats() Get a {@link SearchEngineManagerStats) object.
void	removeSearchEngineByID(long searchEngineID) Remove the search engine by its ID.
boolean	testSearchEngineByID(long searchEngineID) Test the search engine by its ID.
void	updateSearchEngine(SearchEngine searchEngine) Update the managed search engine.

Methods inherited from interface com.jivesoftware.community.JiveManager

destroy, initialize

Method Detail

addSearchEngineFromDescriptorURL

SearchEngine addSearchEngineFromDescriptorURL(java.lang.String URL)
                                              throws OpenSearchDescriptorParseException

Add a search engine to be managed. It will use the URl of its descriptor document and parse it to create the object.

Parameters:

URL - The URL of the search engine descriptor document.

Returns:

the newly created searchEngine

Throws:

OpenSearchDescriptorParseException - If descriptor can't be parsed.

addSearchEngine

void addSearchEngine(SearchEngine searchEngine)

Add a search engine to be managed.

Parameters:

searchEngine - The search engine instance to be managed.

getSearchEngineByID

SearchEngine getSearchEngineByID(long searchEngineID)

Find a managed search engine by its ID.

Parameters:

searchEngineID - the ID of the search engine.

Returns:

the search engine, or null if none found.

getSearchEngines

java.util.Collection<SearchEngine> getSearchEngines()

Get a List of all managed search engines.

Returns:

a List of all search engines.

updateSearchEngine

void updateSearchEngine(SearchEngine searchEngine)

Update the managed search engine.

Parameters:

searchEngine - the search engine to update.

removeSearchEngineByID

void removeSearchEngineByID(long searchEngineID)

Remove the search engine by its ID.

Parameters:

searchEngineID - the ID of the search engine

testSearchEngineByID

boolean testSearchEngineByID(long searchEngineID)

Test the search engine by its ID.

Parameters:

searchEngineID - the ID of the search engine

Returns:

true if the query succeeds, false otherwise

getStats

SearchEngineManagerStats getStats()

Get a {@link SearchEngineManagerStats) object.

Returns:

a SearchEngineManagerStats object.