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 java.lang.String	APPLICATION The parameter for the application name to search
static java.lang.String	MAXHITS The parameter for the maximum number of hits to return
static java.lang.String	PROJECT The parameter for the project name to search

Method Summary

java.lang.String	buildQueryString() Converts the parameter into a queryString suitable for a URL.
java.lang.String	getName()
java.lang.String	getValue()

Field Detail

MAXHITS

static final java.lang.String MAXHITS

The parameter for the maximum number of hits to return

See Also:

Constant Field Values

APPLICATION

static final java.lang.String APPLICATION

The parameter for the application name to search

See Also:

Constant Field Values

PROJECT

static final java.lang.String PROJECT

The parameter for the project name to search

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns:

the name of the search parameter

getValue

java.lang.String getValue()

Returns:

the value of the search parameter

buildQueryString

java.lang.String buildQueryString()

Converts the parameter into a queryString suitable for a URL.

Returns:

querystring to add to a URL