com.hcl.domino.data

Interface DocumentProperties.DocumentProperty

Enclosing interface:

DocumentProperties

public static interface DocumentProperties.DocumentProperty

Interface to define properties of an individual Item, without requiring constant reference to the underlying Item.

Since:

0.5.0

Author:

Paul Withers

Method Summary

Modifier and Type	Method and Description
String	getFieldName() The Item name.
Set<Item.ItemFlag>	getFlags() Gets all the field flags corresponding to the Item
int	getSequenceNumber() Incremental integer for the nth save this Item was last updated.
ItemDataType	getType() Gets the data type for a field, converting it to the more readable enum
List<Object>	getValue() Decodes the item value(s).
String	getValueAsString() Concatenates the list of values as text.

Method Detail

getFieldName

String getFieldName()

The Item name. Items beginning with $ are by convention system fields, e.g.

• $UpdatedBy for list of editors (including by signers of programmatic code
• $Revisions for the list of date/times the Document was saved
• $FILE for attachments in the Document (each file will be in an Item always called "$FILE", not "$FILE1", "$FILE2" etc.

Returns:

the Item's name, never null

getFlags

Set<Item.ItemFlag> getFlags()

Gets all the field flags corresponding to the Item

Returns:

field flags applied, e.g. {SUMMARY,READERS}

getSequenceNumber

int getSequenceNumber()

Incremental integer for the nth save this Item was last updated. Cross-reference with the $Revisions field for the date and time it was saved. Be aware that for very frequently updating documents, the integer will cycle back to 1

Returns:

integer corresponding to the nth time the document was saved, never null

getType

ItemDataType getType()

Gets the data type for a field, converting it to the more readable enum

Returns:

enum corresponding to the internal int value for the data type

getValue

List<Object> getValue()

Decodes the item value(s). The data is always returned as a list even though the list may contain only one element (e.g. for ItemDataType.TYPE_TEXT.
The following data types are currently supported:

• ItemDataType.TYPE_TEXT - List with String object
• ItemDataType.TYPE_TEXT_LIST - List of String objects
• ItemDataType.TYPE_NUMBER - List with Double object
• ItemDataType.TYPE_NUMBER_RANGE - List of Double objects
• ItemDataType.TYPE_TIME - List with Calendar object
• ItemDataType.TYPE_TIME_RANGE - List of Calendar objects
• ItemDataType.TYPE_OBJECT with the subtype Attachment (e.g. $File items) - List with Attachment object
• ItemDataType.TYPE_NOTEREF_LIST - List with one UNID
• ItemDataType.TYPE_UNAVAILABLE - returns an empty list

Other data types may be read via Typed#getValueAsText(char) or native support may be added at a later time.

Returns:

list of values, never null. If empty, the value will be a List with a single empty string

getValueAsString

String getValueAsString()

Concatenates the list of values as text. TODO: Define format of dates - system format?

Returns:

the value as a single String