Package com.atlassian.sal.api.search

Interface SearchMatch

public interface SearchMatch
A single match for a query (i.e. and issue, a wiki page, a commit). The Match contains a URL, Title and possibly an excerpt. The resourceType contains more information about the source of this searchMatch.
Since:
2.0

  • Method Details

    • getUrl

      String getUrl()
      Absolute URL to reach this search match.
      Returns:
      Absolute URL to reach this search match.

    • getTitle

      String getTitle()
      Title of the search match
      Returns:
      Title of the search match

    • getExcerpt

      String getExcerpt()
      An excerpt of the search match. For example this could be a summary of the Wiki page.
      Returns:
      excerpt of the search match. May be null.

    • getResourceType

      ResourceType getResourceType()
      Contains more information about the source of this match.
      Returns:
      The source resourceType.