com.atlassian.confluence.search
Class SearchResultRenderContext

java.lang.Object
  com.atlassian.confluence.search.SearchResultRenderContext

public class SearchResultRenderContext
extends java.lang.Object

Render context for search results. The class provides an easy way to add additional information that the renderes can make use of.

Constructor Summary

SearchResultRenderContext()
Default constructor.

SearchResultRenderContext(java.lang.String queryString, java.lang.String showExcerpts)
Constructor that sets both the queryString and showExcepts properties.

Method Summary

java.lang.String	getQueryString() Return the query string if set, otherwise returns empty string.
java.lang.String	getShowExcerpts() Return the showExceprts if set otherwise return empty string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchResultRenderContext

public SearchResultRenderContext(java.lang.String queryString,
                                 java.lang.String showExcerpts)

Constructor that sets both the queryString and showExcepts properties.

Parameters:

queryString - the query string used when the search was performed.

showExcerpts - indicates if excerpts should be shown. This is largely a legacy thing.

SearchResultRenderContext

public SearchResultRenderContext()

Default constructor.

Method Detail

getQueryString

public java.lang.String getQueryString()

Return the query string if set, otherwise returns empty string.

Returns:

Query string or "" if it is not set.

getShowExcerpts

public java.lang.String getShowExcerpts()

Return the showExceprts if set otherwise return empty string.

Returns:

showExceprts or "" if it is not set.