@PublicApi public final enum

JiraPermissionHolderType

extends Enum<E extends Enum<E>>
implements PermissionHolderType
java.lang.Object
   ↳ java.lang.Enum<E extends java.lang.Enum<E>>
     ↳ com.atlassian.jira.permission.JiraPermissionHolderType

@PublicApi

This enum 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 holder types defined by JIRA.

Summary

Enum Values
JiraPermissionHolderType  ANYONE  Anyone, including anonymous users. 
JiraPermissionHolderType  APPLICATION_ROLE  Application Role. 
JiraPermissionHolderType  ASSIGNEE  Issue assignee. 
JiraPermissionHolderType  ASSIGNEE_WITH_ASSIGNABLE_PERMISSION  This type can be used only with BROWSE_PROJECTS permission to show only projects where the user has the assignable permission and issues within that where they are the assignee. 
JiraPermissionHolderType  GROUP  Group. 
JiraPermissionHolderType  GROUP_CUSTOM_FIELD  Group selected in the group custom field specified by the parameter. 
JiraPermissionHolderType  PROJECT_LEAD  Project lead. 
JiraPermissionHolderType  PROJECT_ROLE  Project role. 
JiraPermissionHolderType  REPORTER  Issue reporter. 
JiraPermissionHolderType  REPORTER_WITH_CREATE_PERMISSION  This type can be used only with BROWSE_PROJECTS permission to show only projects where the user has create permission and issues within that where they are the reporter. 
JiraPermissionHolderType  USER  Specific user. 
JiraPermissionHolderType  USER_CUSTOM_FIELD  User selected in the user custom field specified by the parameter. 
Public Methods
static Option<JiraPermissionHolderType> fromKey(String key, String parameter)
Given a type key and an optional parameter tries to resolve the type.
String getKey()
Key as stored in the database.
boolean requiresParameter()
Whether the type requires additional argument (e.g.
static JiraPermissionHolderType valueOf(String name)
final static JiraPermissionHolderType[] values()
[Expand]
Inherited Methods
From class java.lang.Enum
From class java.lang.Object
From interface com.atlassian.jira.permission.PermissionHolderType
From interface java.lang.Comparable

Enum Values

public static final JiraPermissionHolderType ANYONE

Anyone, including anonymous users. No parameter.

public static final JiraPermissionHolderType APPLICATION_ROLE

Application Role. Parameter is required and it should be a valid application name.

public static final JiraPermissionHolderType ASSIGNEE

Issue assignee. No parameter.

public static final JiraPermissionHolderType ASSIGNEE_WITH_ASSIGNABLE_PERMISSION

This type can be used only with BROWSE_PROJECTS permission to show only projects where the user has the assignable permission and issues within that where they are the assignee.

Note: This holder type is optional and it's not normally available.

public static final JiraPermissionHolderType GROUP

Group. Parameter is required and it should be a group name.

public static final JiraPermissionHolderType GROUP_CUSTOM_FIELD

Group selected in the group custom field specified by the parameter.

public static final JiraPermissionHolderType PROJECT_LEAD

Project lead. No parameter.

public static final JiraPermissionHolderType PROJECT_ROLE

Project role. Parameter is the role's id.

public static final JiraPermissionHolderType REPORTER

Issue reporter. No parameter.

public static final JiraPermissionHolderType REPORTER_WITH_CREATE_PERMISSION

This type can be used only with BROWSE_PROJECTS permission to show only projects where the user has create permission and issues within that where they are the reporter.

Note: This holder type is optional and it's not normally available.

public static final JiraPermissionHolderType USER

Specific user. Parameter is the user's id.

public static final JiraPermissionHolderType USER_CUSTOM_FIELD

User selected in the user custom field specified by the parameter.

Public Methods

public static Option<JiraPermissionHolderType> fromKey (String key, String parameter)

Given a type key and an optional parameter tries to resolve the type. Parameter is required as an argument because there are some types which have the same key but are differentiated by the parameter presence or absence.

Parameters
key type key
parameter parameter. The value doesn't really matter, rather whether it's provided or not.
Returns
  • A type if key/parameter was identified as one of the standard JIRA types, none otherwise

public String getKey ()

Key as stored in the database.

public boolean requiresParameter ()

Whether the type requires additional argument (e.g. user id).

Returns
  • true if argument is required, false otherwise.

public static JiraPermissionHolderType valueOf (String name)

public static final JiraPermissionHolderType[] values ()