net.rcarz.jiraclient.greenhopper

Class RapidView

java.lang.Object

net.rcarz.jiraclient.greenhopper.GreenHopperResource

net.rcarz.jiraclient.greenhopper.RapidView

public class RapidView
extends GreenHopperResource

Represents a GreenHopper Rapid Board.

Field Summary

Fields inherited from class net.rcarz.jiraclient.greenhopper.GreenHopperResource

id, RESOURCE_URI, restclient

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	canEdit()
static RapidView	get(RestClient restclient, int id) Retrieves the given rapid view.
static List<RapidView>	getAll(RestClient restclient) Retrieves all rapid views visible to the session user.
Backlog	getBacklogData() Retrieves the backlog data for this rapid view.
String	getName()
SprintReport	getSprintReport(Sprint sprint) Retrieves the sprint report for the given sprint.
List<Sprint>	getSprints() Retrieves all sprints associated with this rapid view.
Boolean	isSprintSupportEnabled()
String	toString()

Methods inherited from class net.rcarz.jiraclient.greenhopper.GreenHopperResource

getId

Methods inherited from class java.lang.Object

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

Constructor Detail

RapidView

protected RapidView(RestClient restclient,
         net.sf.json.JSONObject json)

Creates a rapid view from a JSON payload.

Parameters:

restclient - REST client instance

json - JSON payload

Method Detail

get

public static RapidView get(RestClient restclient,
            int 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<RapidView> getAll(RestClient restclient)
                              throws JiraException

Retrieves all rapid views visible to the session user.

Parameters:

restclient - REST client instance

Returns:

a list of rapid views

Throws:

JiraException - when the retrieval fails

getSprints

public List<Sprint> getSprints()
                        throws JiraException

Retrieves all sprints associated with this rapid view.

Returns:

a list of sprints

Throws:

JiraException - when the retrieval fails

getSprintReport

public SprintReport getSprintReport(Sprint sprint)
                             throws JiraException

Retrieves the sprint report for the given sprint.

Parameters:

sprint - Sprint to lookup

Returns:

the sprint report

Throws:

JiraException - when the retrieval fails

getBacklogData

public Backlog getBacklogData()
                       throws JiraException

Retrieves the backlog data for this rapid view.

Returns:

the backlog

Throws:

JiraException - when the retrieval fails

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

canEdit

public Boolean canEdit()

isSprintSupportEnabled

public Boolean isSprintSupportEnabled()