com.atlassian.jira.permission

Enum JiraPermissionHolderType

java.lang.Object

java.lang.Enum<JiraPermissionHolderType>

com.atlassian.jira.permission.JiraPermissionHolderType

All Implemented Interfaces:

PermissionHolderType, Serializable, Comparable<JiraPermissionHolderType>

@PublicApi
public enum JiraPermissionHolderType
extends Enum<JiraPermissionHolderType>
implements PermissionHolderType

Permission holder types defined by JIRA.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANYONE Anyone, including anonymous users.
APPLICATION_ROLE Application Role.
ASSIGNEE Issue assignee.
ASSIGNEE_WITH_ASSIGNABLE_PERMISSION This type can be used only with ProjectPermissions.BROWSE_PROJECTS permission to show only projects where the user has the assignable permission and issues within that where they are the assignee.
GROUP Group.
GROUP_CUSTOM_FIELD Group selected in the group custom field specified by the parameter.
PROJECT_LEAD Project lead.
PROJECT_ROLE Project role.
REPORTER Issue reporter.
REPORTER_WITH_CREATE_PERMISSION This type can be used only with ProjectPermissions.BROWSE_PROJECTS permission to show only projects where the user has create permission and issues within that where they are the reporter.
USER Specific user.
USER_CUSTOM_FIELD User selected in the user custom field specified by the parameter.

Method Summary

Modifier and Type	Method and Description
static io.atlassian.fugue.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) Returns the enum constant of this type with the specified name.
static JiraPermissionHolderType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GROUP

public static final JiraPermissionHolderType GROUP

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

ANYONE

public static final JiraPermissionHolderType ANYONE

Anyone, including anonymous users. No parameter.

USER

public static final JiraPermissionHolderType USER

Specific user. Parameter is the user's id.

PROJECT_ROLE

public static final JiraPermissionHolderType PROJECT_ROLE

Project role. Parameter is the role's id.

REPORTER

public static final JiraPermissionHolderType REPORTER

Issue reporter. No parameter.

PROJECT_LEAD

public static final JiraPermissionHolderType PROJECT_LEAD

Project lead. No parameter.

ASSIGNEE

public static final JiraPermissionHolderType ASSIGNEE

Issue assignee. No parameter.

USER_CUSTOM_FIELD

public static final JiraPermissionHolderType USER_CUSTOM_FIELD

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

GROUP_CUSTOM_FIELD

public static final JiraPermissionHolderType GROUP_CUSTOM_FIELD

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

REPORTER_WITH_CREATE_PERMISSION

public static final JiraPermissionHolderType REPORTER_WITH_CREATE_PERMISSION

This type can be used only with ProjectPermissions.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.

ASSIGNEE_WITH_ASSIGNABLE_PERMISSION

public static final JiraPermissionHolderType ASSIGNEE_WITH_ASSIGNABLE_PERMISSION

This type can be used only with ProjectPermissions.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.

APPLICATION_ROLE

public static final JiraPermissionHolderType APPLICATION_ROLE

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

Method Detail

values

public static JiraPermissionHolderType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JiraPermissionHolderType c : JiraPermissionHolderType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JiraPermissionHolderType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getKey

public String getKey()

Key as stored in the database.

Specified by:

getKey in interface PermissionHolderType

requiresParameter

public boolean requiresParameter()

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

Specified by:

requiresParameter in interface PermissionHolderType

Returns:

true if argument is required, false otherwise.

fromKey

public static io.atlassian.fugue.Option<JiraPermissionHolderType> fromKey(String key,
                                                                          @Nullable
                                                                          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