Package org.eclipse.help.search
Interface ISearchResult
-
public interface ISearchResultThis class holds information for a single Search Result- Since:
- 3.6
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDescription()Get the description of this search result topicStringgetHref()Get the href of this search result topicURLgetIcon()Gets the Icon for this topicStringgetId()Gets the IDStringgetLabel()Gets the label for this search resultStringgetParticipantId()Gets the participant IDfloatgetScore()Gets the score float value associated with this search resultStringgetSummary()Gets a summary of this search resultITocgetToc()Gets the IToc parent of this resultbooleanisPotentialHit()Returns whether the result a potential hit
-
-
-
Method Detail
-
getHref
String getHref()
Get the href of this search result topic- Returns:
- the href of this search result topic
-
getDescription
String getDescription()
Get the description of this search result topic- Returns:
- the description of this search result topic
-
getSummary
String getSummary()
Gets a summary of this search result- Returns:
- a summary of this search result
-
getLabel
String getLabel()
Gets the label for this search result- Returns:
- the label for this search result
-
getId
String getId()
Gets the ID- Returns:
- the ID
-
getParticipantId
String getParticipantId()
Gets the participant ID- Returns:
- the participant ID
-
getIcon
URL getIcon()
Gets the Icon for this topic- Returns:
- the Icon for this topic
-
getScore
float getScore()
Gets the score float value associated with this search result- Returns:
- the score float value associated with this search result
-
getToc
IToc getToc()
Gets the IToc parent of this result- Returns:
- the IToc parent of this result
-
isPotentialHit
boolean isPotentialHit()
Returns whether the result a potential hit- Returns:
trueif the result a potential hit,falseotherwise
-
-