@PublicApi public interface

ProjectRole

com.atlassian.jira.security.roles.ProjectRole
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 way to group users (RoleActors) with projects.

An example would be a global role called "testers". If you have a project X and a project Y, you would then be able to configure different RoleActors in the "testers" role for project X than for project Y.

You can use ProjectRole objects as the target of Notification and Permission schemes.

Summary

Public Methods
String getDescription()
Will get the description of this role, null if not set.
Long getId()
Will return the unique identifier for this project role.
String getName()
Will get the name of this role, null if not set.

Public Methods

public String getDescription ()

Will get the description of this role, null if not set.

Returns
  • description or null if not set

public Long getId ()

Will return the unique identifier for this project role.

Returns
  • Long the unique id for this proejct role.

public String getName ()

Will get the name of this role, null if not set.

Returns
  • name or null if not set