@PublicApi public interface

PermissionHolderType

com.atlassian.jira.permission.PermissionHolderType
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

Type of a permission holder.

Types are stored in the DB and identifies by keys. Each type can specify whether it expects an additional parameter.

Standard JIRA permission holder types are defined in the JiraPermissionHolderType enum.

Implementations of this interface are required to be immutable.

Summary

Public Methods
String getKey()
Returns a key that will be stored in the database and identify this holder type.
boolean requiresParameter()
True if this type requires an additional parameter, false otherwise.

Public Methods

public String getKey ()

Returns a key that will be stored in the database and identify this holder type.

public boolean requiresParameter ()

True if this type requires an additional parameter, false otherwise.