com.atlassian.jira.rest.client
Interface SearchRestClient

public interface SearchRestClient

The client handling search REST resource

Since:

2.0 client, 4.3 server

Method Summary

com.atlassian.util.concurrent.Promise<SearchResult>	searchJql(java.lang.String jql) Performs a JQL search and returns issues matching the query
com.atlassian.util.concurrent.Promise<SearchResult>	searchJql(java.lang.String jql, int maxResults, int startAt) Performs a JQL search and returns issues matching the query using default maxResults (as configured in JIRA - usually 50) and startAt=0

Method Detail

searchJql

com.atlassian.util.concurrent.Promise<SearchResult> searchJql(@Nullable
                                                              java.lang.String jql)

Performs a JQL search and returns issues matching the query

Parameters:

jql - a valid JQL query (will be properly encoded by JIRA client). Restricted JQL characters (like '/') must be properly escaped.

Returns:

issues matching given JQL query

Throws:

RestClientException - in case of problems (connectivity, malformed messages, invalid JQL query, etc.)

searchJql

com.atlassian.util.concurrent.Promise<SearchResult> searchJql(@Nullable
                                                              java.lang.String jql,
                                                              int maxResults,
                                                              int startAt)

Performs a JQL search and returns issues matching the query using default maxResults (as configured in JIRA - usually 50) and startAt=0

Parameters:

jql - a valid JQL query (will be properly encoded by JIRA client). Restricted JQL characters (like '/') must be properly escaped.

maxResults - maximum results (page/window size) for this search. The page will contain issues from startAt div maxResults (no remnant) and will include at most maxResults matching issues.

startAt - starting index (0-based) defining the page/window for the results. It will be aligned by the server to the beginning on the page (startAt = startAt div maxResults). For example for startAt=5 and maxResults=3 the results will include matching issues with index 3, 4 and 5. For startAt = 6 and maxResults=3 the issues returned are from position 6, 7 and 8.

Returns:

issues matching given JQL query

Throws:

RestClientException - in case of problems (connectivity, malformed messages, invalid JQL query, etc.)