net.rcarz.jiraclient

Class Project

java.lang.Object

net.rcarz.jiraclient.Resource

net.rcarz.jiraclient.Project

public class Project
extends Resource

Represents a JIRA project.

Field Summary

Fields inherited from class net.rcarz.jiraclient.Resource

apirev, DEFAULT_API_REV, id, restclient, self

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static Project	get(RestClient restclient, String key) Retrieves the given project record.
static List<Project>	getAll(RestClient restclient) Retrieves all project records visible to the session user.
String	getAssigneeType()
Map<String,String>	getAvatarUrls()
List<Component>	getComponents()
String	getDescription()
List<IssueType>	getIssueTypes()
String	getKey()
User	getLead()
String	getName()
Map<String,String>	getRoles()
List<Version>	getVersions()
String	toString()

Methods inherited from class net.rcarz.jiraclient.Resource

getApiRev, getBaseUri, getId, getSelf, getUrl, setApiRev

Methods inherited from class java.lang.Object

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

Constructor Detail

Project

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

Creates a project from a JSON payload.

Parameters:

restclient - REST client instance

json - JSON payload

Method Detail

get

public static Project get(RestClient restclient,
          String key)
                   throws JiraException

Retrieves the given project record.

Parameters:

restclient - REST client instance

key - Project key

Returns:

a project instance

Throws:

JiraException - when the retrieval fails

getAll

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

Retrieves all project records visible to the session user.

Parameters:

restclient - REST client instance

Returns:

a list of projects

Throws:

JiraException - when the retrieval fails

toString

public String toString()

Overrides:

toString in class Object

getAvatarUrls

public Map<String,String> getAvatarUrls()

getKey

public String getKey()

getName

public String getName()

getDescription

public String getDescription()

getLead

public User getLead()

getAssigneeType

public String getAssigneeType()

getComponents

public List<Component> getComponents()

getIssueTypes

public List<IssueType> getIssueTypes()

getVersions

public List<Version> getVersions()

getRoles

public Map<String,String> getRoles()