@PublicApi public interface

ProjectComponent

implements ProjectConstant
com.atlassian.jira.bc.project.component.ProjectComponent
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

A key domain object representing a "working part" of a Project such that an Issue can be raised against or be relevant only to some parts. Typical usage in projects to develop a technology product have a ProjectComponent for each subsystem or module, e.g. GUI, Database, Indexing, Importing. Components can have a lead, or user responsible for the issues raised against that component. The AssigneeType value (AssigneeTypes) refers to the default assignee for issues raised on that component.

Summary

Public Methods
long getAssigneeType()
Returns the assignee type.
ApplicationUser getComponentLead()
Returns the lead for this project component.
String getDescription()
Returns the component description.
GenericValue getGenericValue()
This method is deprecated. use this object instead of the stinky GenericValue!
Long getId()
Returns the component ID.
String getLead()
Returns the key of the lead for this project component.
String getName()
Returns the name of this project component.
Long getProjectId()
Returns the id of the project of this component.
[Expand]
Inherited Methods
From interface com.atlassian.jira.project.ProjectConstant

Public Methods

public long getAssigneeType ()

Returns the assignee type.

Returns
  • the assignee type.
See Also

public ApplicationUser getComponentLead ()

Returns the lead for this project component.

Returns
  • the lead for this project component

public String getDescription ()

Returns the component description.

Returns
  • component description

public GenericValue getGenericValue ()

This method is deprecated.
use this object instead of the stinky GenericValue!

Returns
  • the underlying GenericValue

public Long getId ()

Returns the component ID.

Returns
  • component ID

public String getLead ()

Returns the key of the lead for this project component.

Returns
  • userkey of the lead for this project component

public String getName ()

Returns the name of this project component.

Returns
  • name of this project component

public Long getProjectId ()

Returns the id of the project of this component.

Returns
  • the project's id.