CDField (HCL Domino API 1.0.27-SNAPSHOT API)

All Superinterfaces:

MemoryStructure, ResizableMemoryStructure, RichTextRecord<WSIG>
```
public interface CDField
extends RichTextRecord<WSIG>
```
Since:

1.0.24

Author:

Jesse Gallagher

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class CDField.Flag

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CDField.Flag`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default String`	`getDefaultValueFormula()`
`int`	`getDefaultValueLength()`
`default String`	`getDescription()`
`int`	`getDescriptionLength()`
`ItemDataType`	`getFieldType()`
`Set<CDField.Flag>`	`getFlags()`
`FontStyle`	`getFontStyle()`
`WSIG`	`getHeader()`
`default String`	`getInputTranslationFormula()`
`int`	`getInputTranslationLength()`
`default String`	`getInputValidationFormula()`
`int`	`getInputValidationLength()`
`short`	`getListDelimiterRaw()`
`Set<FieldListDelimiter>`	`getListDelimiters()`
`default FieldListDisplayDelimiter`	`getListDisplayDelimiter()`
`default String`	`getName()`
`int`	`getNameLength()`
`NFMT`	`getNumberFormat()`
`int`	`getTabOrder()`
`default Optional<String>`	`getTextValueFormula()`
`int`	`getTextValueLength()`
`default Optional<List<String>>`	`getTextValues()`
`TFMT`	`getTimeFormat()`
`default CDField`	`setDefaultValueFormula(String formula)`
`CDField`	`setDefaultValueLength(int len)`
`default CDField`	`setDescription(String description)`
`CDField`	`setDescriptionLength(int len)`
`CDField`	`setFieldType(ItemDataType fieldType)`
`CDField`	`setFlags(Collection<CDField.Flag> flags)`
`default CDField`	`setInputTranslationFormula(String formula)`
`CDField`	`setInputTranslationLength(int len)`
`default CDField`	`setInputValidationFormula(String formula)`
`CDField`	`setInputValidationLength(int len)`
`CDField`	`setListDelimiterRaw(short listDelim)`
`default CDField`	`setListDelimiters(Collection<FieldListDelimiter> delimiters)`
`default CDField`	`setListDisplayDelimiter(FieldListDisplayDelimiter delimiter)`
`default CDField`	`setName(String name)`
`CDField`	`setNameLength(int len)`
`CDField`	`setTabOrder(int tabOrder)`
`default CDField`	`setTextValueFormula(String formula)`
`CDField`	`setTextValueLength(int len)`
`default CDField`	`setTextValues(Collection<String> values)`

Methods inherited from interface com.hcl.domino.richtext.records.RichTextRecord
getCDRecordLength, getData, getDataWithoutHeader, getPayloadLength, getRecordHeaderLength, getType, getTypeValue

Methods inherited from interface com.hcl.domino.richtext.structures.ResizableMemoryStructure
getVariableData, resize, resizeVariableData

Method Detail

getHeader
```
WSIG getHeader()
```
Specified by:

getHeader in interface RichTextRecord<WSIG>

getFlags
```
Set<CDField.Flag> getFlags()
```

setFlags

CDField setFlags(Collection<CDField.Flag> flags)

getFieldType
```
ItemDataType getFieldType()
```

setFieldType

CDField setFieldType(ItemDataType fieldType)

getListDelimiterRaw
```
short getListDelimiterRaw()
```

setListDelimiterRaw

CDField setListDelimiterRaw(short listDelim)

getListDelimiters

Set<FieldListDelimiter> getListDelimiters()

setListDelimiters

default CDField setListDelimiters(Collection<FieldListDelimiter> delimiters)

getListDisplayDelimiter

default FieldListDisplayDelimiter getListDisplayDelimiter()

setListDisplayDelimiter

default CDField setListDisplayDelimiter(FieldListDisplayDelimiter delimiter)

getNumberFormat
```
NFMT getNumberFormat()
```

getTimeFormat
```
TFMT getTimeFormat()
```

getFontStyle
```
FontStyle getFontStyle()
```

getDefaultValueLength
```
int getDefaultValueLength()
```

setDefaultValueLength

CDField setDefaultValueLength(int len)

getInputTranslationLength
```
int getInputTranslationLength()
```

setInputTranslationLength

CDField setInputTranslationLength(int len)

getTabOrder
```
int getTabOrder()
```

setTabOrder
```
CDField setTabOrder(int tabOrder)
```

getInputValidationLength
```
int getInputValidationLength()
```

setInputValidationLength

CDField setInputValidationLength(int len)

getNameLength
```
int getNameLength()
```

setNameLength
```
CDField setNameLength(int len)
```

getDescriptionLength
```
int getDescriptionLength()
```

setDescriptionLength
```
CDField setDescriptionLength(int len)
```

getTextValueLength
```
int getTextValueLength()
```

setTextValueLength
```
CDField setTextValueLength(int len)
```

getDefaultValueFormula

default String getDefaultValueFormula()

setDefaultValueFormula

default CDField setDefaultValueFormula(String formula)

getInputTranslationFormula

default String getInputTranslationFormula()

setInputTranslationFormula

default CDField setInputTranslationFormula(String formula)

getInputValidationFormula

default String getInputValidationFormula()

setInputValidationFormula

default CDField setInputValidationFormula(String formula)

getName
```
default String getName()
```

setName
```
default CDField setName(String name)
```

getDescription
```
default String getDescription()
```

setDescription

default CDField setDescription(String description)

getTextValues
```
default Optional<List<String>> getTextValues()
```
Returns:

an Optional describing the explicit text value options for this field, or an empty one if the values are defined by a formula

setTextValues

default CDField setTextValues(Collection<String> values)

getTextValueFormula
```
default Optional<String> getTextValueFormula()
```
Returns:

an Optional describing the value formula for field choices, or an empty one if the values are defined by a an explicit text list

setTextValueFormula

default CDField setTextValueFormula(String formula)

Interface CDField

Nested Class Summary

Method Summary

Methods inherited from interface com.hcl.domino.richtext.records.RichTextRecord

Methods inherited from interface com.hcl.domino.richtext.structures.ResizableMemoryStructure

Method Detail

getHeader

getFlags

setFlags

getFieldType

setFieldType

getListDelimiterRaw

setListDelimiterRaw

getListDelimiters

setListDelimiters

getListDisplayDelimiter

setListDisplayDelimiter

getNumberFormat

getTimeFormat

getFontStyle

getDefaultValueLength

setDefaultValueLength

getInputTranslationLength

setInputTranslationLength

getTabOrder

setTabOrder

getInputValidationLength

setInputValidationLength

getNameLength

setNameLength

getDescriptionLength

setDescriptionLength

getTextValueLength

setTextValueLength

getDefaultValueFormula

setDefaultValueFormula

getInputTranslationFormula

setInputTranslationFormula

getInputValidationFormula

setInputValidationFormula

getName

setName

getDescription

setDescription

getTextValues

setTextValues

getTextValueFormula

setTextValueFormula