com.hcl.domino.richtext.records

Enum CDField.Flag

java.lang.Object

java.lang.Enum<CDField.Flag>

com.hcl.domino.richtext.records.CDField.Flag

All Implemented Interfaces:

INumberEnum<Short>, Serializable, Comparable<CDField.Flag>

Enclosing interface:

CDField

public static enum CDField.Flag
extends Enum<CDField.Flag>
implements INumberEnum<Short>

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPUTED Field is a computed field
EDITABLE Field is editable, not read only
KEYWORDS Field is a keywords field
KEYWORDS_UI_ALLOW_NEW allow doc editor to add new values
KEYWORDS_UI_CHECKBOX checkbox UI
KEYWORDS_UI_RADIOBUTTON radiobutton UI
KEYWORDS_UI_STANDARD standard UI
NAMES Field contains distinguished names
PROTECTED Field is protected
READERS Field contains document readers
READWRITERS Field contains read/writers
REFERENCE Field name is simply a reference to a shared field note
SEAL seal field
SECTION Field contains a section
SIGN sign field
SPARE3 can be assumed to be clear in memory, V3 & later
STOREDV Store DV, even if not spec'ed by user
V3FAB IF CLEAR, CLEAR AS ABOVE

Method Summary

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

READWRITERS

public static final CDField.Flag READWRITERS

Field contains read/writers

EDITABLE

public static final CDField.Flag EDITABLE

Field is editable, not read only

NAMES

public static final CDField.Flag NAMES

Field contains distinguished names

STOREDV

public static final CDField.Flag STOREDV

Store DV, even if not spec'ed by user

READERS

public static final CDField.Flag READERS

Field contains document readers

SECTION

public static final CDField.Flag SECTION

Field contains a section

SPARE3

public static final CDField.Flag SPARE3

can be assumed to be clear in memory, V3 & later

V3FAB

public static final CDField.Flag V3FAB

IF CLEAR, CLEAR AS ABOVE

COMPUTED

public static final CDField.Flag COMPUTED

Field is a computed field

KEYWORDS

public static final CDField.Flag KEYWORDS

Field is a keywords field

PROTECTED

public static final CDField.Flag PROTECTED

Field is protected

REFERENCE

public static final CDField.Flag REFERENCE

Field name is simply a reference to a shared field note

SIGN

public static final CDField.Flag SIGN

sign field

SEAL

public static final CDField.Flag SEAL

seal field

KEYWORDS_UI_STANDARD

public static final CDField.Flag KEYWORDS_UI_STANDARD

standard UI

KEYWORDS_UI_CHECKBOX

public static final CDField.Flag KEYWORDS_UI_CHECKBOX

checkbox UI

KEYWORDS_UI_RADIOBUTTON

public static final CDField.Flag KEYWORDS_UI_RADIOBUTTON

radiobutton UI

KEYWORDS_UI_ALLOW_NEW

public static final CDField.Flag KEYWORDS_UI_ALLOW_NEW

allow doc editor to add new values

Method Detail

values

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

Returns:

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

valueOf

public static CDField.Flag 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

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum as a long

getValue

public Short getValue()

Specified by:

getValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum