AclFlag (HCL Domino API 1.0.27-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<AclFlag>
- - com.hcl.domino.security.AclFlag

All Implemented Interfaces:: INumberEnum<Short>, Serializable, Comparable<AclFlag>

public enum AclFlag
extends Enum<AclFlag>
implements INumberEnum<Short>

These symbols represent access level modifier flags in access control lists.

Each access level taken by itself implies a certain set of immutable capabilities.
Each access level has a different set of access modifier bits that are relevant for that level.

All of the other bits that are returned in the Access Flag parameter of C API functions are irrelevant and are unpredictable.

The table depicts which Access Level Modifier Flags (`AclFlag`) are applicable to the Access Levels (`AclLevel`)
`AclLevel`		`AclFlag` Applicable to `AclLevel`
`AclLevel.MANAGER`	`NODELETE` `PERSON` `GROUP` `SERVER`
`AclLevel.DESIGNER`	`NODELETE` `CREATE_LOTUSSCRIPT` `PERSON` `GROUP` `SERVER`
`AclLevel.EDITOR`	`NODELETE` `CREATE_PRAGENT` `CREATE_PRFOLDER` `CREATE_FOLDER` `CREATE_LOTUSSCRIPT` `PERSON` `GROUP` `SERVER`
`AclLevel.AUTHOR`	`AUTHOR_NOCREATE` `NODELETE` `CREATE_PRAGENT` `CREATE_PRFOLDER` `CREATE_LOTUSSCRIPT` `PUBLICWRITER` `PERSON` `GROUP` `SERVER`
`AclLevel.READER`	`CREATE_PRAGENT` `CREATE_PRFOLDER` `CREATE_LOTUSSCRIPT` `PUBLICWRITER` `PERSON` `GROUP` `SERVER`
`AclLevel.DEPOSITOR`	`PUBLICREADER` `PUBLICWRITER` `PERSON` `GROUP` `SERVER`
`AclLevel.NOACCESS`	`PUBLICREADER` `PUBLICWRITER` `PERSON` `GROUP` `SERVER`

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADMIN_READERAUTHOR` Admin server can modify reader and author fields in db
`ADMIN_SERVER` Entry is administration server (V4)
`AUTHOR_NOCREATE` Authors can't create new notes (only edit existing ones)
`CREATE_FOLDER` User can create and update shared views & folders (V4) This allows an Editor to assume some Designer-level access
`CREATE_LOTUSSCRIPT` User can create LotusScript
`CREATE_PRAGENT` User can create personal agents (V4)
`CREATE_PRFOLDER` User can create personal folders (V4)
`GROUP` Entry represents a group (V4)
`MONITORS_DISALLOWED` User CANNOT register monitors for this database
`NODELETE` User cannot delete notes
`NOREPLICATE` User cannot replicate or copy this database
`PERSON` Entry represents a Person (V4)
`PUBLICREADER` User can read public notes
`PUBLICWRITER` User can write public notes
`SERVER` Entry represents a Server (V4)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getLongValue()`
`Short`	`getValue()`
`static AclFlag`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AclFlag[]`	`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
  - AUTHOR_NOCREATE
```
public static final AclFlag AUTHOR_NOCREATE
```
    Authors can't create new notes (only edit existing ones)
  - SERVER
```
public static final AclFlag SERVER
```
    Entry represents a Server (V4)
  - NODELETE
```
public static final AclFlag NODELETE
```
    User cannot delete notes
  - CREATE_PRAGENT
```
public static final AclFlag CREATE_PRAGENT
```
    User can create personal agents (V4)
  - CREATE_PRFOLDER
```
public static final AclFlag CREATE_PRFOLDER
```
    User can create personal folders (V4)
  - PERSON
```
public static final AclFlag PERSON
```
    Entry represents a Person (V4)
  - GROUP
```
public static final AclFlag GROUP
```
    Entry represents a group (V4)
  - CREATE_FOLDER
```
public static final AclFlag CREATE_FOLDER
```
    User can create and update shared views & folders (V4)
    This allows an Editor to assume some Designer-level access
  - CREATE_LOTUSSCRIPT
```
public static final AclFlag CREATE_LOTUSSCRIPT
```
    User can create LotusScript
  - PUBLICREADER
```
public static final AclFlag PUBLICREADER
```
    User can read public notes
  - PUBLICWRITER
```
public static final AclFlag PUBLICWRITER
```
    User can write public notes
  - MONITORS_DISALLOWED
```
public static final AclFlag MONITORS_DISALLOWED
```
    User CANNOT register monitors for this database
  - NOREPLICATE
```
public static final AclFlag NOREPLICATE
```
    User cannot replicate or copy this database
  - ADMIN_READERAUTHOR
```
public static final AclFlag ADMIN_READERAUTHOR
```
    Admin server can modify reader and author fields in db
  - ADMIN_SERVER
```
public static final AclFlag ADMIN_SERVER
```
    Entry is administration server (V4)
- Method Detail
  - values
```
public static AclFlag[] 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 (AclFlag c : AclFlag.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AclFlag 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 Short getValue()
```
    Specified by:
    
    getValue in interface INumberEnum<Short>
    
    Returns:
    
    the C-level value of the enum
  - getLongValue
```
public long getLongValue()
```
    Specified by:
    
    getLongValue in interface INumberEnum<Short>
    
    Returns:
    
    the C-level value of the enum as a long

Enum AclFlag

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AUTHOR_NOCREATE

SERVER

NODELETE

CREATE_PRAGENT

CREATE_PRFOLDER

PERSON

GROUP

CREATE_FOLDER

CREATE_LOTUSSCRIPT

PUBLICREADER

PUBLICWRITER

MONITORS_DISALLOWED

NOREPLICATE

ADMIN_READERAUTHOR

ADMIN_SERVER

Method Detail

values

valueOf

getValue

getLongValue