public interface

SearchResult

implements BaseSearchResult
com.atlassian.confluence.search.v2.SearchResult
Known Indirect Subclasses

Class Overview

An individual search result. The SearchResult provides access to a number of attributes that are populated directly from the index without requiring an additional database hit. There should be enough information directly in the result to give a pretty detailed description of the hit. It is heavier than it's parent @see BaseSearchResult which should be used in preference when the lucene fields required to be accessed can be known by the developer in advance of the lucene query being executed.

Summary

Public Methods
String getContent()
Gets the text content of the search result.
Integer getContentVersion()
Returns the version of the content if available, or null if there's no version for this result.
Date getCreationDate()
String getCreator()
String getDisplayTitle()
Gets the title of the search result appropriate for displaying to a user.
Map<String, String> getExtraFields()
If the retrieved documents contain additional fields that cannot be directly accessed by this interface then they can be retrieved via this method.
Set<String> getLabels(User user)
Gets the labels on the current search result that are visible to the specified user.
Date getLastModificationDate()
Gets the last modification date of the entity represented by the search result.
String getLastModifier()
Gets the username of the last person to modify the entity represented by the search result.
String getLastUpdateDescription()
Gets some string describing the last modification to this content.
String getOwnerTitle()
If this result represents an attachment then this field will return the title of the page or blog post the attachment is attached to.
String getOwnerType()
If this result represents an attachment then this field will return the type of the container, a page or blogpost.
Set<String> getPersonalLabels()
Gets all the personal labels on the current search result.
String getSpaceKey()
String getSpaceName()
String getType()
Gets a string representation of the type of the entity represented by the search result.
String getUrlPath()
Gets the URL path to the search result, relative to the site's context root.
boolean hasLabels()
boolean isHomePage()
Checks if the search result represents the homepage of a space.
[Expand]
Inherited Methods
From interface com.atlassian.confluence.search.v2.BaseSearchResult

Public Methods

public String getContent ()

Gets the text content of the search result.

Returns
  • the text content of the search result

public Integer getContentVersion ()

Returns the version of the content if available, or null if there's no version for this result.

Throws
NumberFormatException if the document in the index has an unparseable version number

public Date getCreationDate ()

public String getCreator ()

public String getDisplayTitle ()

Gets the title of the search result appropriate for displaying to a user. All results should return something useful for this method.

Returns
  • the title of the search result appropriate for display on a page
See Also

public Map<String, String> getExtraFields ()

If the retrieved documents contain additional fields that cannot be directly accessed by this interface then they can be retrieved via this method.

The field names are abstracted from the underlying search implementation and will be centrally defined. Their values are not yet documented.

Returns
  • Map of additional field names and their values.

public Set<String> getLabels (User user)

Gets the labels on the current search result that are visible to the specified user.

Parameters
user filter labels by this user
Returns
  • the labels on the current search result that are visible to the specified user.

public Date getLastModificationDate ()

Gets the last modification date of the entity represented by the search result.

Returns
  • the last modification date of the entity

public String getLastModifier ()

Gets the username of the last person to modify the entity represented by the search result.

Returns
  • the username of the result's last modifier

public String getLastUpdateDescription ()

Gets some string describing the last modification to this content. May be null if no such string is available. For content objects, this will be the same as the "version comment"

This string is user-supplied, and therefore not internationalised

Returns
  • a string describing the last modification to the content
See Also

public String getOwnerTitle ()

If this result represents an attachment then this field will return the title of the page or blog post the attachment is attached to.

Returns
  • the owner title

public String getOwnerType ()

If this result represents an attachment then this field will return the type of the container, a page or blogpost.

Returns
  • the owner type

public Set<String> getPersonalLabels ()

Gets all the personal labels on the current search result.

Returns
  • all the personal labels on the current search result

public String getSpaceKey ()

Returns
  • the key of the space that contains this search result

public String getSpaceName ()

Returns
  • the name of the space that contains this search result.

public String getType ()

Gets a string representation of the type of the entity represented by the search result. If the entity is a content object, this is the value of getType()

Returns
  • the type of the entity represented as a string, or null if no such type can be determined
See Also

public String getUrlPath ()

Gets the URL path to the search result, relative to the site's context root. All results should return something useful for this method

Returns
  • the URL path to the search result
See Also

public boolean hasLabels ()

Returns
  • true if this search result has labels, false otherwise.

public boolean isHomePage ()

Checks if the search result represents the homepage of a space.

Returns
  • true if the result represents the homepage of a space