com.atlassian.jira.sharing.search

Enum SharedEntitySearchContext

java.lang.Object

java.lang.Enum<SharedEntitySearchContext>

com.atlassian.jira.sharing.search.SharedEntitySearchContext

All Implemented Interfaces:

Serializable, Comparable<SharedEntitySearchContext>

@PublicApi
public enum SharedEntitySearchContext
extends Enum<SharedEntitySearchContext>

Indicates the context of a shared entity search, shared entities can be searched in "USER" or "ADMINISTRATION" context.

When searching within a USER context, the search is being performed with the objective of using the results in jira as a user, e.g. favourite the result, use it in a dashboard, see its content in the issue navigator...

Conversely, a search in "ADMINISTRATION" context is being done with the objective of performing administration tasks on the returned search entities, e.g. Delete the entity, change its owner, change its sharing permissions.

Only JIRA Administrators are able to perform "ADMINISTRATION" context queries.

Since:

v4.4

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMINISTER
USE

Method Summary

Modifier and Type	Method and Description
static SharedEntitySearchContext	valueOf(String name) Returns the enum constant of this type with the specified name.
static SharedEntitySearchContext[]	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

USE

public static final SharedEntitySearchContext USE

ADMINISTER

public static final SharedEntitySearchContext ADMINISTER

Method Detail

values

public static SharedEntitySearchContext[] 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 (SharedEntitySearchContext c : SharedEntitySearchContext.values())
    System.out.println(c);

Returns:

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

valueOf

public static SharedEntitySearchContext 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