net.rcarz.jiraclient.agile

Class Epic

java.lang.Object

net.rcarz.jiraclient.agile.AgileResource

net.rcarz.jiraclient.agile.Epic

public class Epic
extends AgileResource

Represents an Agile Epic.

Author:

pldupont

Field Summary

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

ATTR_ID, ATTR_NAME, ATTR_SELF, RESOURCE_URI

Constructor Summary

Constructors

Constructor and Description
Epic(RestClient restclient, net.sf.json.JSONObject json) Creates a new Agile resource.

Method Summary

Modifier and Type	Method and Description
Issue	asIssue(boolean refresh)
static Epic	get(RestClient restclient, long id) Retrieves the epic matching the ID.
List<Issue>	getIssues()
String	getKey()
String	getSummary()
boolean	isDone()

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

Epic

public Epic(RestClient restclient,
            net.sf.json.JSONObject json)
     throws JiraException

Creates a new Agile resource.

Parameters:

restclient - REST client instance

json - JSON payload

Throws:

JiraException

Method Detail

get

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

Retrieves the epic matching the ID.

Parameters:

restclient - REST client instance

id - Internal JIRA ID of the epic

Returns:

an epic instance

Throws:

JiraException - when the retrieval fails

asIssue

public Issue asIssue(boolean refresh)
              throws JiraException

Parameters:

refresh - If true, will fetch the information from JIRA, otherwise use the cached info.

Returns:

The Issue representation of this Epic.

Throws:

JiraException - when the retrieval fails

getIssues

public List<Issue> getIssues()
                      throws JiraException

Returns:

All issues in the Epic.

Throws:

JiraException - when the retrieval fails

getKey

public String getKey()

getSummary

public String getSummary()

isDone

public boolean isDone()