DocumentClass (HCL Domino API 1.0.27-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<DocumentClass>
- - com.hcl.domino.data.DocumentClass

All Implemented Interfaces:

INumberEnum<Short>, Serializable, Comparable<DocumentClass>
```
public enum DocumentClass
extends Enum<DocumentClass>
implements INumberEnum<Short>
```
These bit masks define the types of notes in a database. The bit masks may be or'ed together to specify more than one type of note.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACL` acl note
`ALL` all note types
`ALLNONDATA` all non-data notes
`DATA` old name for document note
`DEFAULT` MODIFIER - default version of each
`DESIGNCOLLECTION` design note collection
`DOCUMENT` document note
`FIELD` field note
`FILTER` filter note
`FORM` form note
`HELP` designer's help note
`HELP_INDEX` Notes product help index note
`ICON` icon note
`INFO` notefile info (help-about) note
`NONE` no notes
`NOTIFYDELETION` marker included in deletion stubs found in a query result
`PRIVATE` Private design note, use $PrivateDesign view to locate/classify
`REPLFORMULA` replication formula
`SINGLE_INSTANCE` Define symbol for those note classes that allow only one such in a file
`VIEW` view note

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getLongValue()`
`Short`	`getValue()`
`static boolean`	`isDesignElement(Set<DocumentClass> docClass)`
`static DocumentClass`	`toNoteClass(int val)`
`static DocumentClass`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DocumentClass[]`	`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
  - DATA
```
public static final DocumentClass DATA
```
    old name for document note
  - DOCUMENT
```
public static final DocumentClass DOCUMENT
```
    document note
  - INFO
```
public static final DocumentClass INFO
```
    notefile info (help-about) note
  - FORM
```
public static final DocumentClass FORM
```
    form note
  - VIEW
```
public static final DocumentClass VIEW
```
    view note
  - ICON
```
public static final DocumentClass ICON
```
    icon note
  - DESIGNCOLLECTION
```
public static final DocumentClass DESIGNCOLLECTION
```
    design note collection
  - ACL
```
public static final DocumentClass ACL
```
    acl note
  - HELP_INDEX
```
public static final DocumentClass HELP_INDEX
```
    Notes product help index note
  - HELP
```
public static final DocumentClass HELP
```
    designer's help note
  - FILTER
```
public static final DocumentClass FILTER
```
    filter note
  - FIELD
```
public static final DocumentClass FIELD
```
    field note
  - REPLFORMULA
```
public static final DocumentClass REPLFORMULA
```
    replication formula
  - PRIVATE
```
public static final DocumentClass PRIVATE
```
    Private design note, use $PrivateDesign view to locate/classify
  - DEFAULT
```
public static final DocumentClass DEFAULT
```
    MODIFIER - default version of each
  - NOTIFYDELETION
```
public static final DocumentClass NOTIFYDELETION
```
    marker included in deletion stubs found in a query result
  - ALL
```
public static final DocumentClass ALL
```
    all note types
  - ALLNONDATA
```
public static final DocumentClass ALLNONDATA
```
    all non-data notes
  - NONE
```
public static final DocumentClass NONE
```
    no notes
  - SINGLE_INSTANCE
```
public static final DocumentClass SINGLE_INSTANCE
```
    Define symbol for those note classes that allow only one such in a file
- Method Detail
  - values
```
public static DocumentClass[] 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 (DocumentClass c : DocumentClass.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DocumentClass 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
  - toNoteClass
```
public static DocumentClass toNoteClass(int val)
```
  - 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
  - isDesignElement
```
public static boolean isDesignElement(Set<DocumentClass> docClass)
```

Enum DocumentClass

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DATA

DOCUMENT

INFO

FORM

VIEW

ICON

DESIGNCOLLECTION

ACL

HELP_INDEX

HELP

FILTER

FIELD

REPLFORMULA

PRIVATE

DEFAULT

NOTIFYDELETION

ALL

ALLNONDATA

NONE

SINGLE_INSTANCE

Method Detail

values

valueOf

toNoteClass

getValue

getLongValue

isDesignElement