com.atlassian.sal.api.search.parameter
Interface SearchParameter


public interface SearchParameter

Allows to specify additional properties for a search in terms of string value pairs. For example this could specify a fixforversion=3.12 in JIRA. Or application=crucible in Fisheye.

Since:
2.0

Field Summary
static String APPLICATION
          The parameter for the application name to search
static String MAXHITS
          The parameter for the maximum number of hits to return
static String PROJECT
          The parameter for the project name to search
 
Method Summary
 String buildQueryString()
          Converts the parameter into a queryString suitable for a URL.
 String getName()
           
 String getValue()
           
 

Field Detail

MAXHITS

static final String MAXHITS
The parameter for the maximum number of hits to return

See Also:
Constant Field Values

APPLICATION

static final String APPLICATION
The parameter for the application name to search

See Also:
Constant Field Values

PROJECT

static final String PROJECT
The parameter for the project name to search

See Also:
Constant Field Values
Method Detail

getName

String getName()
Returns:
the name of the search parameter

getValue

String getValue()
Returns:
the value of the search parameter

buildQueryString

String buildQueryString()
Converts the parameter into a queryString suitable for a URL.

Returns:
querystring to add to a URL


Copyright © 2010 Atlassian. All Rights Reserved.