com.atlassian.jira.project

Interface Project

All Superinterfaces:

Named, NamedWithDescription, WithId, WithKey

All Known Implementing Classes:

MockProject, ProjectImpl

@PublicApi
public interface Project
extends Named, NamedWithDescription, WithId, WithKey

Defines a project in JIRA.

Method Summary

Methods

Modifier and Type	Method and Description
Long	getAssigneeType() Returns the default assignee for issues that get created in this project.
Avatar	getAvatar() Gives the currently-configured Avatar for this project.
Collection<org.ofbiz.core.entity.GenericValue>	getComponents() Deprecated. Use getProjectComponents(). Since v4.1.
Long	getCounter() Deprecated. (since 5.0) The counter is not something users of project information should concern themselves with. This call delegates through to ProjectManager.getCurrentCounterForProject().
String	getDescription()
String	getEmail()
org.ofbiz.core.entity.GenericValue	getGenericValue() Deprecated. only use this if you need to utilize an older API method
Long	getId()
Collection<IssueType>	getIssueTypes()
String	getKey()
com.atlassian.crowd.embedded.api.User	getLead() Deprecated. Use getProjectLead(), which returns application users, instead. Since v6.0.
com.atlassian.crowd.embedded.api.User	getLeadUser() Deprecated. Use getLead() instead.
String	getLeadUserKey()
String	getLeadUserName()
String	getName()
String	getOriginalKey()
org.ofbiz.core.entity.GenericValue	getProjectCategory() Deprecated. Use getProjectCategoryObject() instead. Since v5.1.
ProjectCategory	getProjectCategoryObject()
Collection<ProjectComponent>	getProjectComponents() Returns the components for this Project.
ApplicationUser	getProjectLead()
String	getUrl()
Collection<Version>	getVersions()

Method Detail

getId

Long getId()

Specified by:

getId in interface WithId

Returns:

the id of the project

getName

String getName()

Specified by:

getName in interface Named

Returns:

the name of the project.

getKey

String getKey()

Specified by:

getKey in interface WithKey

Returns:

the project key.

getUrl

String getUrl()

Returns:

the project URL

getEmail

String getEmail()

Returns:

the project email address from which email notifications are sent.

getLead

com.atlassian.crowd.embedded.api.User getLead()

Deprecated. Use getProjectLead(), which returns application users, instead. Since v6.0.

Returns:

the Project Lead

getLeadUser

com.atlassian.crowd.embedded.api.User getLeadUser()

Deprecated. Use getLead() instead.

Returns the Project Lead

Returns:

the Project Lead

getLeadUserName

String getLeadUserName()

Returns:

the user name of the project lead

getDescription

String getDescription()

Specified by:

getDescription in interface NamedWithDescription

Returns:

the project description

getAssigneeType

Long getAssigneeType()

Returns the default assignee for issues that get created in this project. Returns AssigneeTypes.PROJECT_LEAD or AssigneeTypes.UNASSIGNED. Can return NULL if the default assignee has not been set for this project and this means the PROJECT LEAD is the default assignee. TODO: Write upgrade task to ensure default assignee is always set.

Returns:

the default assignee. NB: Can return NULL

getCounter

Long getCounter()

Deprecated. (since 5.0) The counter is not something users of project information should concern themselves with. This call delegates through to ProjectManager.getCurrentCounterForProject().

Returns:

the last number used to generate an issue key. E.g. Counter = 2, issue key: HSP-2

getComponents

Collection<org.ofbiz.core.entity.GenericValue> getComponents()

Deprecated. Use getProjectComponents(). Since v4.1.

Returns the components for this Project.

Returns:

the components for this Project.

See Also:

getProjectComponents()

getProjectComponents

Collection<ProjectComponent> getProjectComponents()

Returns the components for this Project.

Returns:

the components for this Project.

getVersions

Collection<Version> getVersions()

Returns:

a Collection of Version for this project

getIssueTypes

Collection<IssueType> getIssueTypes()

Returns:

a Collection of IssueType for this project

getProjectCategory

org.ofbiz.core.entity.GenericValue getProjectCategory()

Deprecated. Use getProjectCategoryObject() instead. Since v5.1.

Returns:

a GV containing the project category information for this project.

getProjectCategoryObject

ProjectCategory getProjectCategoryObject()

Returns:

the project category information for this project.

getGenericValue

org.ofbiz.core.entity.GenericValue getGenericValue()

Deprecated. only use this if you need to utilize an older API method

Returns:

the GenericValue backing this project object

getAvatar

@Nonnull
Avatar getAvatar()

Gives the currently-configured Avatar for this project.

Returns:

the current Avatar (or default if the current one is removed), never null.

getProjectLead

ApplicationUser getProjectLead()

Returns:

the Project Lead

getLeadUserKey

String getLeadUserKey()

Returns:

the Project Lead's userkey

getOriginalKey

@Internal
String getOriginalKey()

Returns:

the project key with which Project was originally created