1 package com.atlassian.sal.api.search.parameter;
2
3 /**
4 * Allows to specify additional properties for a search in terms of string value pairs. For example this could
5 * specify a fixforversion=3.12 in JIRA. Or application=crucible in Fisheye.
6 *
7 * @since 2.0
8 */
9 public interface SearchParameter
10 {
11 /**
12 * The parameter for the maximum number of hits to return
13 */
14 public static final String MAXHITS = "maxhits";
15
16 /**
17 * The parameter for the application name to search
18 */
19 public static final String APPLICATION = "application";
20
21 /**
22 * The parameter for the project name to search
23 */
24 public static final String PROJECT = "project";
25
26 /**
27 * @return the name of the search parameter
28 */
29 String getName();
30
31 /**
32 * @return the value of the search parameter
33 */
34 String getValue();
35
36 /**
37 * Converts the parameter into a queryString suitable for a URL.
38 *
39 * @return querystring to add to a URL
40 */
41 String buildQueryString();
42 }