ome.model.internal

Enum Permissions.Right

java.lang.Object

java.lang.Enum<Permissions.Right>

ome.model.internal.Permissions.Right

All Implemented Interfaces:

Serializable, Comparable<Permissions.Right>

Enclosing class:

Permissions

public static enum Permissions.Right
extends Enum<Permissions.Right>

enumeration of granted rights. The READ right allows for a user with the given role to retrieve an entity. This means that all fields of that entity can be retrieved. Care is taken by the server, that once an entity was readable and another entity was attached to it, that further READ access will not throw an exception. In turn, care should be taken by users to not overly soon grant READ permissions lest they no longer be revokable. As of 4.4, this also permits certain view-based linkages of objects (e.g. RenderingDef, Thumbnail). The ANNOTATE right allows a user with the given role to link annotations and other non-core data to an entity. The WRITE right allows for a user with the given role to alter the fields of an entity, including changing the contents of its collection, assigning it to another collection, or deleting it. This does not include changing the fields of those linked entities, only whether or not they are members of the given collection. Note: if WRITE is granted, ANNOTATE will also be granted.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOTATE
READ
WRITE

Method Summary

Methods

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

ANNOTATE

public static final Permissions.Right ANNOTATE

WRITE

public static final Permissions.Right WRITE

READ

public static final Permissions.Right READ

Method Detail

values

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

Returns:

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

valueOf

public static Permissions.Right 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