@PublicApi public interface

PermissionScheme

implements WithId NamedWithDescription
com.atlassian.jira.permission.PermissionScheme
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

Permission scheme is a set of rules that govern permissions for different activities within a project.

Permission scheme consists of a list of PermissionGrants. Each scheme has a unique name and an optional description.

Implementations of this interface are required to be immutable.

Summary

[Expand]
Inherited Fields
From interface com.atlassian.jira.entity.WithId
From interface com.atlassian.jira.util.Named
Public Methods
@Nonnull String getDescription()
Returns an optional description of this scheme.
@Nonnull Long getId()
Returns an id of the permission grant as stored in DB.
@Nonnull String getName()
Returns the permission scheme name.
@Nonnull Collection<PermissionGrant> getPermissions()
Returns a collection of permission grants defined in this scheme.
[Expand]
Inherited Methods
From interface com.atlassian.jira.entity.WithId
From interface com.atlassian.jira.util.Named
From interface com.atlassian.jira.util.NamedWithDescription

Public Methods

@Nonnull public String getDescription ()

Returns an optional description of this scheme. If description is not defined then an empty String will be returned.

Returns
  • non-null String, may be empty.

@Nonnull public Long getId ()

Returns an id of the permission grant as stored in DB.

@Nonnull public String getName ()

Returns the permission scheme name.

@Nonnull public Collection<PermissionGrant> getPermissions ()

Returns a collection of permission grants defined in this scheme.