net.rcarz.jiraclient.agile

Class AgileClient

java.lang.Object

net.rcarz.jiraclient.agile.AgileClient

public class AgileClient
extends Object

An Agile extension to the JIRA client.

Author:

pldupont

See Also:

"https://docs.atlassian.com/jira-software/REST/cloud/"

Constructor Summary

Constructors

Constructor and Description
AgileClient(JiraClient jira) Creates an Agile client.

Method Summary

Modifier and Type	Method and Description
Board	getBoard(long id) Retrieves the board with the given ID.
List<Board>	getBoards() Retrieves all boards visible to the session user.
Epic	getEpic(long id) Retrieves the epic with the given ID.
Issue	getIssue(long id) Retrieves the issue with the given ID.
Issue	getIssue(String key) Retrieves the issue with the given Key.
RestClient	getRestclient()
Sprint	getSprint(long id) Retrieves the sprint with the given ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgileClient

public AgileClient(JiraClient jira)

Creates an Agile client.

Parameters:

jira - JIRA client

Method Detail

getBoard

public Board getBoard(long id)
               throws JiraException

Retrieves the board with the given ID.

Parameters:

id - Board ID

Returns:

a Board instance

Throws:

JiraException - when something goes wrong

getBoards

public List<Board> getBoards()
                      throws JiraException

Retrieves all boards visible to the session user.

Returns:

a list of boards

Throws:

JiraException - when something goes wrong

getSprint

public Sprint getSprint(long id)
                 throws JiraException

Retrieves the sprint with the given ID.

Parameters:

id - Sprint ID

Returns:

a Sprint instance

Throws:

JiraException - when something goes wrong

getIssue

public Issue getIssue(long id)
               throws JiraException

Retrieves the issue with the given ID.

Parameters:

id - Issue ID

Returns:

an Issue instance

Throws:

JiraException - when something goes wrong

getIssue

public Issue getIssue(String key)
               throws JiraException

Retrieves the issue with the given Key.

Parameters:

key - Issue Key

Returns:

an Issue instance

Throws:

JiraException - when something goes wrong

getEpic

public Epic getEpic(long id)
             throws JiraException

Retrieves the epic with the given ID.

Parameters:

id - Epic ID

Returns:

an Epic instance

Throws:

JiraException - when something goes wrong

getRestclient

public RestClient getRestclient()