com.atlassian.confluence.plugin
Interface SearchResultRenderer

All Known Implementing Classes:

DefaultSearchResultResultRenderer

public interface SearchResultRenderer

Interface for plugins that will provide a customized rendering of a search result should implement.

Method Summary

boolean	canRender(SearchResult searchResult) Indicates if this paricular plugin can (and want) to render the given search result.
java.lang.String	render(SearchResult searchResult, SearchResultRenderContext renderContext) Render the given search result.

Method Detail

canRender

boolean canRender(SearchResult searchResult)

Indicates if this paricular plugin can (and want) to render the given search result. Return true if and only if the plugin can render the given item without throwing exceptions. Note that several plugins can return true for the same SearchResult in which case one will be picked in an undefined order.

Parameters:

searchResult - Search result to render.

showExcerpts - indicates if the caller requested to have excerpts shown, a plugin can choose to ignore this request but it is strongly recommended it is respected.

render

java.lang.String render(SearchResult searchResult,
                        SearchResultRenderContext renderContext)

Render the given search result. A display ready html string should be returned. If rendering fails (maybe the attachment to render was removed between the call to canRender and render), the plugin should return null to indicate that it failed to render the result

Parameters:

searchResult - Search result to render.

renderContext - Render context that contains more information that the renderer may make use of.

Returns:

the rendered HTML ready to be sent to the requesting client.