com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client
Class SearchClient

java.lang.Object
  extended by com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient<SearchClient>
      extended by com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.SearchClient

public class SearchClient
extends RestApiClient<SearchClient>

Client for the search resource.

Since:
v4.3

Nested Class Summary
 
Nested classes/interfaces inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient
RestApiClient.Method
 
Field Summary
 
Fields inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient
REST_VERSION
 
Constructor Summary
SearchClient(JIRAEnvironmentData environmentData)
          Constructs a new SearchClient for a JIRA instance.
 
Method Summary
 SearchResult getSearch(SearchRequest searchRequest)
          Performs a search using a GET.
 Response getSearchResponse(SearchRequest searchRequest)
          Performs a search using a GET, and returns a Response.
 SearchResult postSearch(SearchRequest searchRequest)
          Performs a search using a POST.
 Response<SearchResult> postSearchResponse(SearchRequest searchRequest)
          Performs a search using a GET, and returns a Response.
 
Methods inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient
anonymous, createResource, errorResponse, expanded, loginAs, loginAs, percentEncode, resourceRoot, setOf, toResponse, toResponse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchClient

public SearchClient(JIRAEnvironmentData environmentData)
Constructs a new SearchClient for a JIRA instance.

Parameters:
environmentData - The JIRA environment data
Method Detail

getSearch

public SearchResult getSearch(SearchRequest searchRequest)
Performs a search using a GET. The JQL query and other parameters are passed as query parameters.

Parameters:
searchRequest - a SearchRequest object
Returns:
a SearchResult

getSearchResponse

public Response getSearchResponse(SearchRequest searchRequest)
Performs a search using a GET, and returns a Response. The JQL query and other parameters are passed as query parameters.

Parameters:
searchRequest - a SearchRequest object
Returns:
a Response

postSearch

public SearchResult postSearch(SearchRequest searchRequest)
Performs a search using a POST. The JQL query and other parameters are passed in the JSON payload.

Parameters:
searchRequest - a SearchRequest object
Returns:
a SearchResult

postSearchResponse

public Response<SearchResult> postSearchResponse(SearchRequest searchRequest)
Performs a search using a GET, and returns a Response. The JQL query and other parameters are passed in the JSON payload.

Parameters:
searchRequest - a SearchRequest object
Returns:
a Response


Copyright © 2002-2012 Atlassian. All Rights Reserved.