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

java.lang.Object
  com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient<FilterClient>
      com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.FilterClient

public class FilterClient
extends RestApiClient<FilterClient>

Client for the Filter resource.

Since:

v5.0

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

FilterClient(JIRAEnvironmentData environmentData)
Constructs a new FilterClient for a JIRA instance.

Method Summary

protected com.sun.jersey.api.client.WebResource	filterWithId(String filterId) Returns a WebResource for the filter with the given ID.
Filter	get(String filterId) GETs the filter with the given ID.
List<Filter>	getFavouriteFilters()
Response	getResponse(String filterId) GETs the filter with the given ID, 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

FilterClient

public FilterClient(JIRAEnvironmentData environmentData)

Constructs a new FilterClient for a JIRA instance.

Parameters:

environmentData - The JIRA environment data

Method Detail

get

public Filter get(String filterId)
           throws com.sun.jersey.api.client.UniformInterfaceException

GETs the filter with the given ID.

Parameters:

filterId - a String containing a filter id

Returns:

a Filter

Throws:

com.sun.jersey.api.client.UniformInterfaceException - if there is a problem getting the filter

getResponse

public Response getResponse(String filterId)

GETs the filter with the given ID, and returns a Response.

Parameters:

filterId - a String containing a filter ID

Returns:

a Response

getFavouriteFilters

public List<Filter> getFavouriteFilters()

filterWithId

protected com.sun.jersey.api.client.WebResource filterWithId(String filterId)

Returns a WebResource for the filter with the given ID.

Parameters:

filterId - a String containing a filter ID

Returns:

a WebResource