public class

SearchResultRenderContext

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

Class Overview

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

Summary

Public Constructors
SearchResultRenderContext(String queryString, String showExcerpts)
Constructor that sets both the queryString and showExcepts properties.
SearchResultRenderContext()
Default constructor.
Public Methods
String getQueryString()
Return the query string if set, otherwise returns empty string.
String getShowExcerpts()
Return the showExceprts if set otherwise return empty string.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SearchResultRenderContext (String queryString, 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.

public SearchResultRenderContext ()

Default constructor.

Public Methods

public String getQueryString ()

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

Returns
  • Query string or "" if it is not set.

public String getShowExcerpts ()

Return the showExceprts if set otherwise return empty string.

Returns
  • showExceprts or "" if it is not set.