1 package com.atlassian.sal.api.search;
2
3 /**
4 * A single match for a query (i.e. and issue, a wiki page, a commit). The Match contains a URL, Title and possibly
5 * an excerpt. The resourceType contains more information about the source of this searchMatch.
6 *
7 * @since 2.0
8 */
9 public interface SearchMatch {
10 /**
11 * Absolute URL to reach this search match.
12 *
13 * @return Absolute URL to reach this search match.
14 */
15 String getUrl();
16
17 /**
18 * Title of the search match
19 *
20 * @return Title of the search match
21 */
22 String getTitle();
23
24 /**
25 * An excerpt of the search match. For example this could be a summary of the Wiki page.
26 *
27 * @return excerpt of the search match. May be null.
28 */
29 String getExcerpt();
30
31 /**
32 * Contains more information about the source of this match.
33 *
34 * @return The source resourceType.
35 */
36 ResourceType getResourceType();
37
38 }