org.jboss.portal.search
Interface FederatedSearcher

All Known Implementing Classes:

AbstractFederatedSearcher, CMSFederatedSearch, DummyFederatedSearch, GenericSearchFederated, LuceneFederatedSearcher, UserSearcher

public interface FederatedSearcher

Version:

$Revision: 8784 $

Author:

Thomas Heute

Method Summary

LocalizedString	getDisplayName() Get a localized name for this federated search
java.lang.String	getId() Get the ID for this federated search
QueryConverter	getQueryConverter() Returns the query converter to apply on the Query
ResultSet	search(Query query) From the query object this method is responsible to return the results of the query

Method Detail

getId

java.lang.String getId()

Get the ID for this federated search

Returns:

String representing this particular federated search

getDisplayName

LocalizedString getDisplayName()

Get a localized name for this federated search

Returns:

String

getQueryConverter

QueryConverter getQueryConverter()

Returns the query converter to apply on the Query

Returns:

search

ResultSet search(Query query)
                 throws SearchingException

From the query object this method is responsible to return the results of the query

Parameters:

query -

Returns:

Throws:

SearchingException