Clearspace API (2.5.29) Core Javadocs

com.jivesoftware.community.search.opensearch
Interface SearchResult


public interface SearchResult

A SearchResult is a result returned by a query performed against one or many SearchEngines. NOTE: To return a collection of these, the SearchEngine must return true for isQueryResultParseable.

See Also:
SearchEngine

Method Summary
 String getAuthor()
          The author of the result (will be displayed on the view).
 String getDescription()
          The description of the result (will be displayed on the view).
 Date getLastUpdatedDate()
          The last updated date of this resource.
 Date getPublishedDate()
          The published date of this resource.
 String getResourceURL()
          The link to the search result resource.
 String getTitle()
          The title of the result (will be displayed on the view).
 

Method Detail

getTitle

String getTitle()
The title of the result (will be displayed on the view).

Returns:
A String title.

getAuthor

String getAuthor()
The author of the result (will be displayed on the view).

Returns:
A String author.

getDescription

String getDescription()
The description of the result (will be displayed on the view).

Returns:
A String description.

getPublishedDate

Date getPublishedDate()
The published date of this resource.

Returns:
a java.util.Date when the result was published.

getLastUpdatedDate

Date getLastUpdatedDate()
The last updated date of this resource.

Returns:
a java.util.Date when the result was last updated.

getResourceURL

String getResourceURL()
The link to the search result resource.

Returns:
A String URL.

Clearspace Project Page

Copyright © 1999-2007 Jive Software.