com.hcl.domino.security

Enum AclLevel

java.lang.Object

java.lang.Enum<AclLevel>

com.hcl.domino.security.AclLevel

All Implemented Interfaces:

INumberEnum<Integer>, Serializable, Comparable<AclLevel>

public enum AclLevel
extends Enum<AclLevel>
implements INumberEnum<Integer>

Access Control Level symbols used to qualify user or server access to a given Domino database. Note: Currently the values associated with each enum are the same values used by the Notes client. If these values need to be changed, a mapping has to be introduced in the JNA implementation connecting with the Notes C-API.

Author:

Karsten Lehmann

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHOR User or Server can create and/or edit their own data documents and examine existing ones in the database.
DEPOSITOR User or Server can add new data documents to a database, but cannot examine the new document or the database.
DESIGNER User or Server can create and/or edit any data document and/or design document.
EDITOR User or Server can create and/or edit any data document.
MANAGER User or Server can create and/or maintain any type of database or document, including the ACL.
NOACCESS User or Server has no access to the database.
READER User or Server can only view data documents in the database.

Method Summary

Modifier and Type	Method and Description
long	getLongValue()
Integer	getValue() Returns the numeric constant for the access level
static AclLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static AclLevel[]	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

NOACCESS

public static final AclLevel NOACCESS

User or Server has no access to the database.

DEPOSITOR

public static final AclLevel DEPOSITOR

User or Server can add new data documents to a database, but cannot examine the new document or the database.

READER

public static final AclLevel READER

User or Server can only view data documents in the database.

AUTHOR

public static final AclLevel AUTHOR

User or Server can create and/or edit their own data documents and examine existing ones in the database.

EDITOR

public static final AclLevel EDITOR

User or Server can create and/or edit any data document.

DESIGNER

public static final AclLevel DESIGNER

User or Server can create and/or edit any data document and/or design document.

MANAGER

public static final AclLevel MANAGER

User or Server can create and/or maintain any type of database or document, including the ACL.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public Integer getValue()

Returns the numeric constant for the access level

Specified by:

getValue in interface INumberEnum<Integer>

Returns:

constant

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum as a long