net.rcarz.jiraclient.greenhopper

Class SprintReport

java.lang.Object

net.rcarz.jiraclient.greenhopper.SprintReport

public class SprintReport
extends Object

GreenHopper sprint statistics.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static SprintReport	get(RestClient restclient, RapidView rv, Sprint sprint) Retrieves the sprint report for the given rapid view and sprint.
EstimateSum	getAllIssuesEstimateSum()
List<SprintIssue>	getCompletedIssues()
EstimateSum	getCompletedIssuesEstimateSum()
List<SprintIssue>	getIncompletedIssues()
EstimateSum	getIncompletedIssuesEstimateSum()
List<String>	getIssueKeysAddedDuringSprint()
List<SprintIssue>	getPuntedIssues()
EstimateSum	getPuntedIssuesEstimateSum()
Sprint	getSprint()

Methods inherited from class java.lang.Object

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

Constructor Detail

SprintReport

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

Creates a sprint report from a JSON payload.

Parameters:

restclient - REST client instance

json - JSON payload

Method Detail

get

public static SprintReport get(RestClient restclient,
                               RapidView rv,
                               Sprint sprint)
                        throws JiraException

Retrieves the sprint report for the given rapid view and sprint.

Parameters:

restclient - REST client instance

rv - Rapid View instance

sprint - Sprint instance

Returns:

the sprint report

Throws:

JiraException - when the retrieval fails

getSprint

public Sprint getSprint()

getCompletedIssues

public List<SprintIssue> getCompletedIssues()

getIncompletedIssues

public List<SprintIssue> getIncompletedIssues()

getPuntedIssues

public List<SprintIssue> getPuntedIssues()

getCompletedIssuesEstimateSum

public EstimateSum getCompletedIssuesEstimateSum()

getIncompletedIssuesEstimateSum

public EstimateSum getIncompletedIssuesEstimateSum()

getAllIssuesEstimateSum

public EstimateSum getAllIssuesEstimateSum()

getPuntedIssuesEstimateSum

public EstimateSum getPuntedIssuesEstimateSum()

getIssueKeysAddedDuringSprint

public List<String> getIssueKeysAddedDuringSprint()