Package 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 Details

    • 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

      ApplicationUser getLead()
      Deprecated.
      Use getProjectLead(), which returns application users, instead. Since v6.0.
      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

    • getProjectTypeKey

      ProjectTypeKey getProjectTypeKey()
      Returns the key of the project type for this project.
      Returns:
      The key of the project type for this project.
      Since:
      7.0

    • getComponents

      Collection<ProjectComponent> getComponents()
      Returns the components for this Project.
      Returns:
      the components for this Project.

    • getProjectComponents

      Collection<ProjectComponent> getProjectComponents()
      Returns the components for this Project.

      This is a synonym for getComponents() that exists for legacy reasons.

      Returns:
      the components for this Project.
      See Also:

    • 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

      ProjectCategory getProjectCategory()
      Returns:
      the project category information for this project.

    • getProjectCategoryObject

      ProjectCategory getProjectCategoryObject()
      Returns the Project Category for this Project.

      This is a synonym for getProjectCategory() that exists for legacy reasons.

      Returns:
      the project category information for this project.
      See Also:

    • 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

      @Nullable ApplicationUser getProjectLead()
      Returns:
      the Project Lead

    • getLeadUserKey

      @Nullable String getLeadUserKey()
      Returns:
      the Project Lead's userkey

    • getOriginalKey

      @Internal String getOriginalKey()
      Returns:
      the project key with which Project was originally created

    • isArchived

      @ExperimentalApi boolean isArchived()
      Returns:
      true if this project is archived.

    • getArchivedBy

      @ExperimentalApi ApplicationUser getArchivedBy()
      Returns:
      the user who archived this project, or null if it wasn't archived.

    • getArchivedDate

      @ExperimentalApi Date getArchivedDate()
      Returns:
      Date when this project was archived, or null if it wasn't archived.