com.webmethods.common.search

Interface ISearchContext

All Known Subinterfaces:

ISliceableSearchContext

public interface ISearchContext

Portlets should implement this interface to provide The data needed for the portlets on the search page.

Method Summary

Modifier and Type	Method and Description
IRefineableFieldInfo[]	getAdvancedRefineableFields() Return metadata about each of the search fields that should be available for refining a keyword search on the advanced tab
IFilterableFieldInfo[]	getFilterableFields() Return metadata about each of the fields that should be available for filtering a keyword search
IDisplayFieldInfo[]	getKeywordFields() Return the names of each of the fields that will be searched by the keyword search
IRefineableFieldInfo[]	getRefineableFields() Return metadata about each of the search fields that should be available for refining a keyword search on the simple tab
ISearchResultInfo	getSearchResultInfo() Returns metadata about the data in the search results that should be displayed in the search result portlet
Collection<?>	search(ISearchQuery searchQuery) Perform the search logic given the parameters

Method Detail

getKeywordFields

IDisplayFieldInfo[] getKeywordFields()
                              throws PortalException

Return the names of each of the fields that will be searched by the keyword search

Returns:

array of keyword search fields

Throws:

PortalException

getRefineableFields

IRefineableFieldInfo[] getRefineableFields()
                                    throws PortalException

Return metadata about each of the search fields that should be available for refining a keyword search on the simple tab

Returns:

array of refinable fields

Throws:

PortalException

getAdvancedRefineableFields

IRefineableFieldInfo[] getAdvancedRefineableFields()
                                            throws PortalException

Return metadata about each of the search fields that should be available for refining a keyword search on the advanced tab

Returns:

array of refinable fields

Throws:

PortalException

getFilterableFields

IFilterableFieldInfo[] getFilterableFields()
                                    throws PortalException

Return metadata about each of the fields that should be available for filtering a keyword search

Returns:

array of filterable fields

Throws:

PortalException

search

Collection<?> search(ISearchQuery searchQuery)
              throws PortalException

Perform the search logic given the parameters

Parameters:

searchQuery - the query information

Returns:

collection of search results

Throws:

PortalException

getSearchResultInfo

ISearchResultInfo getSearchResultInfo()
                               throws PortalException

Returns metadata about the data in the search results that should be displayed in the search result portlet

Returns:

search result info

Throws:

PortalException