com.logicaldoc.core.security

Enum Permission

java.lang.Object

java.lang.Enum<Permission>

com.logicaldoc.core.security.Permission

All Implemented Interfaces:

Serializable, Comparable<Permission>

public enum Permission
extends Enum<Permission>

Models a permission, that is the ability to do something

• READ: ability to read the folder and its documents
• WRITE: ability to insert and delete folder's documents
• ADD: ability to add child elements
• SECURITY: ability to change security rules
• IMMUTABILE: ability to mark a document as immutable
• DELETE: ability to delete the entity
• RENAME: ability to rename the entity
• IMPORT: ability to import documents
• EXPORT: ability to export documents
• SIGN: ability to digitally sign documents
• ARCHIVE: ability to archive documents
• WORKFLOW: ability to handle workflow
• CALENDAR: ability to handle calendar events

Since:

4.0

Author:

Marco Meschieri - Logical Objects

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD
ARCHIVE
CALENDAR
DELETE
DOWNLOAD
EXPORT
IMMUTABLE
IMPORT
READ
RENAME
SECURITY
SIGN
WORKFLOW
WRITE

Method Summary

Methods

Modifier and Type	Method and Description
static Set<Permission>	all()
int	getMask()
String	getName()
boolean	match(int permission)
String	toString()
static Permission	valueOf(int mask)
static Permission	valueOf(String name) Returns the enum constant of this type with the specified name.
static Permission[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

READ

public static final Permission READ

DOWNLOAD

public static final Permission DOWNLOAD

WRITE

public static final Permission WRITE

ADD

public static final Permission ADD

SECURITY

public static final Permission SECURITY

IMMUTABLE

public static final Permission IMMUTABLE

DELETE

public static final Permission DELETE

RENAME

public static final Permission RENAME

IMPORT

public static final Permission IMPORT

EXPORT

public static final Permission EXPORT

SIGN

public static final Permission SIGN

ARCHIVE

public static final Permission ARCHIVE

WORKFLOW

public static final Permission WORKFLOW

CALENDAR

public static final Permission CALENDAR

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

getMask

public int getMask()

match

public boolean match(int permission)

valueOf

public static Permission valueOf(int mask)

all

public static Set<Permission> all()

toString

public String toString()

Overrides:

toString in class Enum<Permission>