net.rcarz.jiraclient.agile

Class Sprint

java.lang.Object

net.rcarz.jiraclient.agile.AgileResource

net.rcarz.jiraclient.agile.Sprint

public class Sprint
extends AgileResource

Represents an Agile Sprint.

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	Sprint(RestClient restclient, net.sf.json.JSONObject json) Creates a rapid view 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 Sprint	get(RestClient restclient, long sprintId) Retrieve all sprints related to the specified board.
static List<Sprint>	getAll(RestClient restclient, long boardId) Retrieve all sprints related to the specified board.
Date	getCompleteDate()
Date	getEndDate()
List<Issue>	getIssues()
long	getOriginBoardId()
Date	getStartDate()
String	getState()

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

Sprint

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

Creates a rapid view from a JSON payload.

Parameters:

restclient - REST client instance

json - JSON payload

Throws:

JiraException

Method Detail

get

public static Sprint get(RestClient restclient,
                         long sprintId)
                  throws JiraException

Retrieve all sprints related to the specified board.

Parameters:

restclient - REST client instance

sprintId - The Internal JIRA sprint ID.

Returns:

The sprint for the specified ID.

Throws:

JiraException - when the retrieval fails

getAll

public static List<Sprint> getAll(RestClient restclient,
                                  long boardId)
                           throws JiraException

Retrieve all sprints related to the specified board.

Parameters:

restclient - REST client instance

boardId - The Internal JIRA board ID.

Returns:

The list of sprints associated to the board.

Throws:

JiraException - when the retrieval fails

getIssues

public List<Issue> getIssues()
                      throws JiraException

Returns:

All issues in the Sprint.

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

getState

public String getState()

getOriginBoardId

public long getOriginBoardId()

getStartDate

public Date getStartDate()

getEndDate

public Date getEndDate()

getCompleteDate

public Date getCompleteDate()