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

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

public class WorklogClient
extends RestApiClient<WorklogClient>

Client for the work log 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
WorklogClient(JIRAEnvironmentData environmentData)
          Constructs a new WorklogClient for a JIRA instance.
 
Method Summary
 Response delete(String issueKey, Worklog worklog)
           
 Response delete(String issueKey, Worklog worklog, Map<String,String> queryParams)
           
 Worklog get(String issueKey, String worklogID)
          GETs the work log with the given id.
 WorklogWithPaginationBean getAll(String issueKey)
          GETs the work log with the given id, returning a Response object.
 Response getResponse(String issueKey, String worklogID)
          GETs the work log with the given id, returning a Response object.
 Response<Worklog> post(String issueKey, Worklog worklog)
           
 Response<Worklog> post(String issueKey, Worklog worklog, Map<String,String> queryParams)
           
 Response<Worklog> put(String issueKey, Worklog worklog)
           
 Response<Worklog> put(String issueKey, Worklog worklog, Map<String,String> queryParams)
           
protected  com.sun.jersey.api.client.WebResource worklogWithID(String issueKey, String worklogID)
          Returns a WebResource for the work log with the given id.
 
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

WorklogClient

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

Parameters:
environmentData - The JIRA environment data
Method Detail

getAll

public WorklogWithPaginationBean getAll(String issueKey)
GETs the work log with the given id, returning a Response object.

Returns:
a Response

get

public Worklog get(String issueKey,
                   String worklogID)
            throws com.sun.jersey.api.client.UniformInterfaceException
GETs the work log with the given id.

Parameters:
worklogID - a String containing the work log id
Returns:
a Worklog
Throws:
com.sun.jersey.api.client.UniformInterfaceException - if there is a problem getting the work log

getResponse

public Response getResponse(String issueKey,
                            String worklogID)
GETs the work log with the given id, returning a Response object.

Parameters:
worklogID - a String containing the work log id
Returns:
a Response

worklogWithID

protected com.sun.jersey.api.client.WebResource worklogWithID(String issueKey,
                                                              String worklogID)
Returns a WebResource for the work log with the given id.

Parameters:
issueKey - worklog is associated with
worklogID - a String containing the work log id
Returns:
a WebResource

put

public Response<Worklog> put(String issueKey,
                             Worklog worklog)

put

public Response<Worklog> put(String issueKey,
                             Worklog worklog,
                             Map<String,String> queryParams)

post

public Response<Worklog> post(String issueKey,
                              Worklog worklog)

post

public Response<Worklog> post(String issueKey,
                              Worklog worklog,
                              Map<String,String> queryParams)

delete

public Response delete(String issueKey,
                       Worklog worklog)

delete

public Response delete(String issueKey,
                       Worklog worklog,
                       Map<String,String> queryParams)


Copyright © 2002-2012 Atlassian. All Rights Reserved.