|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SearchRestClient
The client handling search REST resource
Method Summary | |
---|---|
SearchResult |
searchJql(String jql,
int maxResults,
int startAt,
ProgressMonitor progressMonitor)
Performs a JQL search and returns issues matching the query using default maxResults (as configured in JIRA - usually 50) and startAt=0 |
SearchResult |
searchJql(String jql,
ProgressMonitor progressMonitor)
Performs a JQL search and returns issues matching the query |
Method Detail |
---|
SearchResult searchJql(@Nullable String jql, ProgressMonitor progressMonitor)
jql
- a valid JQL query (will be properly encoded by JIRA client). Restricted JQL characters (like '/') must be properly escaped.progressMonitor
- progress monitor
RestClientException
- in case of problems (connectivity, malformed messages, invalid JQL query, etc.)SearchResult searchJql(@Nullable String jql, int maxResults, int startAt, ProgressMonitor progressMonitor)
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.progressMonitor
- progress monitor
RestClientException
- in case of problems (connectivity, malformed messages, invalid JQL query, etc.)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |