net.rcarz.jiraclient.agile

Class Board

java.lang.Object

net.rcarz.jiraclient.agile.AgileResource

net.rcarz.jiraclient.agile.Board

public class Board
extends AgileResource

Represents an Agile Board.

Author:

pldupont

Field Summary

Fields inherited from class net.rcarz.jiraclient.agile.AgileResource

ATTR_ID, ATTR_NAME, ATTR_SELF, RESOURCE_URI

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Board(RestClient restclient, net.sf.json.JSONObject json) Creates a Board from a JSON payload.

Method Summary

Modifier and Type	Method and Description
protected void	deserialize(net.sf.json.JSONObject json) Deserialize the json to extract standard attributes and keep a reference of other attributes.
static Board	get(RestClient restclient, long id) Retrieves the given rapid view.
static List<Board>	getAll(RestClient restclient) Retrieves all boards visible to the session user.
List<Issue>	getBacklog()
List<Epic>	getEpics()
List<Issue>	getIssuesWithoutEpic()
List<Sprint>	getSprints()
String	getType()

Methods inherited from class net.rcarz.jiraclient.agile.AgileResource

getAttribute, getId, getName, getResource, getResourceArray, getRestclient, getSelfURL, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Board

protected Board(RestClient restclient,
                net.sf.json.JSONObject json)
         throws JiraException

Creates a Board from a JSON payload.

Parameters:

restclient - REST client instance

json - JSON payload

Throws:

JiraException

Method Detail

get

public static Board get(RestClient restclient,
                        long id)
                 throws JiraException

Retrieves the given rapid view.

Parameters:

restclient - REST client instance

id - Internal JIRA ID of the rapid view

Returns:

a rapid view instance

Throws:

JiraException - when the retrieval fails

getAll

public static List<Board> getAll(RestClient restclient)
                          throws JiraException

Retrieves all boards visible to the session user.

Parameters:

restclient - REST client instance

Returns:

a list of boards

Throws:

JiraException - when the retrieval fails

deserialize

protected void deserialize(net.sf.json.JSONObject json)
                    throws JiraException

Description copied from class: AgileResource

Deserialize the json to extract standard attributes and keep a reference of other attributes.

Parameters:

json - The JSON object to read.

Throws:

JiraException

getType

public String getType()

Returns:

The board type.

getSprints

public List<Sprint> getSprints()
                        throws JiraException

Returns:

All sprints related to the current board.

Throws:

JiraException - when the retrieval fails

getBacklog

public List<Issue> getBacklog()
                       throws JiraException

Returns:

All issues in the Board backlog.

Throws:

JiraException - when the retrieval fails

getIssuesWithoutEpic

public List<Issue> getIssuesWithoutEpic()
                                 throws JiraException

Returns:

All issues without epic in the Board .

Throws:

JiraException - when the retrieval fails

getEpics

public List<Epic> getEpics()
                    throws JiraException

Returns:

All epics associated to the Board.

Throws:

JiraException - when the retrieval fails