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

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

public class VotesClient
extends RestApiClient<VotesClient>

Client for the votes sub-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
VotesClient(JIRAEnvironmentData environmentData)
          Constructs a new VotesClient for a JIRA instance.
 
Method Summary
 Response deleteResponse(String issueKey)
          DELETEs the user's vote from the issue with the given key, returning a Response object.
 Vote get(String issueKey)
          Gets the voters sub-resource for the issue with the given key.
 Response getResponse(String issueKey)
          Gets the voters sub-resource for the issue with the given key, returning a Response object.
 Response postResponse(String issueKey)
          POSTs the users's vote to the issue with the given key, returning a Response object.
 
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

VotesClient

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

Parameters:
environmentData - The JIRA environment data
Method Detail

get

public Vote get(String issueKey)
Gets the voters sub-resource for the issue with the given key.

Parameters:
issueKey - a String containing an issue key
Returns:
a Vote

getResponse

public Response getResponse(String issueKey)
Gets the voters sub-resource for the issue with the given key, returning a Response object.

Parameters:
issueKey - a String containing an issue key
Returns:
a Response

postResponse

public Response postResponse(String issueKey)
POSTs the users's vote to the issue with the given key, returning a Response object.

Parameters:
issueKey - a String containing an issue key
Returns:
a Response

deleteResponse

public Response deleteResponse(String issueKey)
DELETEs the user's vote from the issue with the given key, returning a Response object.

Parameters:
issueKey - a String containing an issue key
Returns:
a Response


Copyright © 2002-2012 Atlassian. All Rights Reserved.