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 * The parameter for the maximum number of hits to return
12 */
13 public static final String MAXHITS = "maxhits";
14
15 /**
16 * The parameter for the application name to search
17 */
18 public static final String APPLICATION = "application";
19
20 /**
21 * The parameter for the project name to search
22 */
23 public static final String PROJECT = "project";
24
25 /**
26 * @return the name of the search parameter
27 */
28 String getName();
29
30 /**
31 * @return the value of the search parameter
32 */
33 String getValue();
34
35 /**
36 * Converts the parameter into a queryString suitable for a URL.
37 *
38 * @return querystring to add to a URL
39 */
40 String buildQueryString();
41 }