com.lexmark.saperion.administration

Enum AccessRight

java.lang.Object

java.lang.Enum<AccessRight>

com.lexmark.saperion.administration.AccessRight

All Implemented Interfaces:

Serializable, Comparable<AccessRight>

public enum AccessRight
extends Enum<AccessRight>

This enumeration defines the different rights an actor may have on a specific object.

Author:

jschwarz

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOTATE This right is only valid on documents.
DELETE A user that has this right on a given entity is allowed to delete the entity.
EDIT_BLACK_MARKERS This right is only valid on documents.
EDIT_CONTENT This right is only valid on documents.
EDIT_INDEX A user that has this right on an entity can change the entities index data.
EDIT_PERMISSIONS A user that has this right on a given entity may change which access control lists apply for the entity.
READ A user that has this right on an entity can load the entity.
RECORDS_MANAGEMENT This right is only valid on documents.
RESTORE_REVISION This right is only valid on entities that have a revision history (documents and folders).
SHOW_HISTORY This right is only valid on entities that have a revision history (documents and folders).
VISIBLE A user that does not have this right on an entity does not know that it exists.
WRITE A user that has this right on an entity is allowed to edit the entity.

Method Summary

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

VISIBLE

public static final AccessRight VISIBLE

A user that does not have this right on an entity does not know that it exists. Queries on the reference of the entity will fail with exceptions that indicate that the entity does not exist. There are however situations where a user can guess that such an entity exists. This is for example the case when there are unique constraints.

READ

public static final AccessRight READ

A user that has this right on an entity can load the entity. This right implies the right VISIBLE.

EDIT_INDEX

public static final AccessRight EDIT_INDEX

A user that has this right on an entity can change the entities index data. For every entity except for documents this is the same as WRITE. This right implies the right READ.

ANNOTATE

public static final AccessRight ANNOTATE

This right is only valid on documents. A user that has this right on a document can edit (create, change and delete) annotations on the given document. This right implies the rights READ and EDIT_BLACK_MARKERS.

EDIT_CONTENT

public static final AccessRight EDIT_CONTENT

This right is only valid on documents. A user that has this right on a document can edit (create, change and delete) content of the given document. This right implies the right READ.

WRITE

public static final AccessRight WRITE

A user that has this right on an entity is allowed to edit the entity. On documents this implies the rights EDIT_INDEX, EDIT_CONTENT and ANNOTATE. On every other entity this is the same as EDIT_INDEX. In any case it implies the right READ.

SHOW_HISTORY

public static final AccessRight SHOW_HISTORY

This right is only valid on entities that have a revision history (documents and folders). A user that has this right on an entity may load every history entry and not only the current one. This right implies the right READ.

RESTORE_REVISION

public static final AccessRight RESTORE_REVISION

This right is only valid on entities that have a revision history (documents and folders). A user that has this right on an entity may create a new revision on the entity that equals to one in the history. This right implies the right SHOW_HISTORY but does not grant other types of editing on the entity.

RECORDS_MANAGEMENT

public static final AccessRight RECORDS_MANAGEMENT

This right is only valid on documents. A user that has this right on a given document is allowed to use the records management api for the given document. This right implies the right READ.

DELETE

public static final AccessRight DELETE

A user that has this right on a given entity is allowed to delete the entity. It implies the right READ.

EDIT_PERMISSIONS

public static final AccessRight EDIT_PERMISSIONS

A user that has this right on a given entity may change which access control lists apply for the entity. It implies the right READ but does not grant any right to edit the ACLs themselves. Access control lists can in turn have access control lists that grant or deny edit rights on them.

EDIT_BLACK_MARKERS

public static final AccessRight EDIT_BLACK_MARKERS

This right is only valid on documents. A user that has this right on a given document is allowed to add black markers to the document. This right implies the right READ.

Method Detail

values

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

Returns:

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

valueOf

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