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 /**
12 * Absolute URL to reach this search match.
13 *
14 * @return Absolute URL to reach this search match.
15 */
16 String getUrl();
17
18 /**
19 * Title of the search match
20 *
21 * @return Title of the search match
22 */
23 String getTitle();
24
25 /**
26 * An excerpt of the search match. For example this could be a summary of the Wiki page.
27 *
28 * @return excerpt of the search match. May be null.
29 */
30 String getExcerpt();
31
32 /**
33 * Contains more information about the source of this match.
34 *
35 * @return The source resourceType.
36 */
37 ResourceType getResourceType();
38
39 }