Package org.eclipse.help.search

Interface ISearchResult

  • public interface ISearchResult
    This class holds information for a single Search Result
    Since:
    3.6

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Get the description of this search result topic
      java.lang.String getHref()
      Get the href of this search result topic
      java.net.URL getIcon()
      Gets the Icon for this topic
      java.lang.String getId()
      Gets the ID
      java.lang.String getLabel()
      Gets the label for this search result
      java.lang.String getParticipantId()
      Gets the participant ID
      float getScore()
      Gets the score float value associated with this search result
      java.lang.String getSummary()
      Gets a summary of this search result
      IToc getToc()
      Gets the IToc parent of this result
      boolean isPotentialHit()
      Returns whether the result a potential hit

    • Method Detail

      • getHref

        java.lang.String getHref()
        Get the href of this search result topic
        Returns:
        the href of this search result topic

      • getDescription

        java.lang.String getDescription()
        Get the description of this search result topic
        Returns:
        the description of this search result topic

      • getSummary

        java.lang.String getSummary()
        Gets a summary of this search result
        Returns:
        a summary of this search result

      • getLabel

        java.lang.String getLabel()
        Gets the label for this search result
        Returns:
        the label for this search result

      • getId

        java.lang.String getId()
        Gets the ID
        Returns:
        the ID

      • getParticipantId

        java.lang.String getParticipantId()
        Gets the participant ID
        Returns:
        the participant ID

      • getIcon

        java.net.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:
        true if the result a potential hit, false otherwise