com.webmethods.common.search.mechanics

Interface ISearchAndFilterMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISystemHandler

public interface ISearchAndFilterMechanics
extends IMechanics

Mechanics for the search and filter logic. The wm_commonsearchresults portlet provides the actual implementation but the interface is in the kernel so other portlets can get the mechanics and execute the methods.

Example code to get a reference to the ISearchAndFilterMechanics:

IMechanicsManager mechManager = (IMechanicsManager)PortalSystem.getMechanicsProvider();
ISearchAndFilterMechanics mech = (ISearchAndFilterMechanics)mechManager.getMechanics("wm_commonsearchresults");


Method Summary

Modifier and Type	Method and Description
ISearchQuery	buildSearchQuery(String searchQuery) Constructs an ISearchQuery object from the given query string.
void	freshenCachedResults() On the next access of getCachedSearchResults method the cached results will be ignored and the search will be performed using the given search context and search query.
Collection<?>	getCachedSearchResults(ISearchContext searchContext, String searchQuery, IPortletControllerBean pcb) Perform a search using the given search context and search query.
Collection<?>	getSearchResults(ISearchContext searchContext, String searchQuery) Perform a search using the given search context and search query.
Collection<?>	getSliceableSearchResults(ISliceableSearchContext searchContext, String searchQuery, Map<String,?> pagingParams) Get the search results for a sliceable search context

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Method Detail

getCachedSearchResults

Collection<?> getCachedSearchResults(ISearchContext searchContext,
                                     String searchQuery,
                                     IPortletControllerBean pcb)
                              throws PortalException

Perform a search using the given search context and search query. If the query is the same as the last search, a cached collection is returned.

Parameters:

searchContext - the context to run the search on

searchQuery - the query string

pcb - the portlet controller bean where the cached search will be stored and retrieved

Returns:

a collection of search results

Throws:

PortalException

getSearchResults

Collection<?> getSearchResults(ISearchContext searchContext,
                               String searchQuery)
                        throws PortalException

Perform a search using the given search context and search query. This method does not attempt to do any caching of the search results.

Parameters:

searchContext - the context to run the search on

searchQuery - the query string

Returns:

a collection of search results

Throws:

PortalException

freshenCachedResults

void freshenCachedResults()

On the next access of getCachedSearchResults method the cached results will be ignored and the search will be performed using the given search context and search query. This is intended for portlets returning to the search context after updating objects found in that search. IE. Alias search results, after editing the alias.

buildSearchQuery

ISearchQuery buildSearchQuery(String searchQuery)

Constructs an ISearchQuery object from the given query string.

Parameters:

searchQuery - string containing all the search terms

Returns:

search query object

getSliceableSearchResults

Collection<?> getSliceableSearchResults(ISliceableSearchContext searchContext,
                                        String searchQuery,
                                        Map<String,?> pagingParams)
                                 throws PortalException

Get the search results for a sliceable search context

Parameters:

searchContext - the search context

searchQuery - the search query

pagingParams - the paging params

Returns:

pre-sliced search results

Throws:

PortalException