@PublicApi public interface

PermissionGrant

implements WithId
com.atlassian.jira.permission.PermissionGrant
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 grant holds information about a permission granted to a certain user or group of users. It is a basic building block of PermissionSchemes.

A grant consists of two things:

holder
A person or group of people that holds the permission, see PermissionHolder for more details.
permission
Project permission that is being granted. For example: view issues, browse projects, add comments. Standard JIRA permissions are defined in the ProjectPermissions class

Implementations of this interface are required to be immutable.

Summary

[Expand]
Inherited Fields
From interface com.atlassian.jira.entity.WithId
Public Methods
@Nonnull PermissionHolder getHolder()
Returns an entity to which the permission is being granted.
@Nonnull Long getId()
Returns an id of the permission grant as stored in DB.
@Nonnull ProjectPermissionKey getPermission()
Returns a permission that is being granted.
[Expand]
Inherited Methods
From interface com.atlassian.jira.entity.WithId

Public Methods

@Nonnull public PermissionHolder getHolder ()

Returns an entity to which the permission is being granted.

@Nonnull public Long getId ()

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

@Nonnull public ProjectPermissionKey getPermission ()

Returns a permission that is being granted.