com.hcl.domino.data

Interface CollectionEntry

All Superinterfaces:

IAdaptable, IndexedTypedAccess, Map<String,Object>, TypedAccess

All Known Subinterfaces:

DeletionStub

public interface CollectionEntry
extends TypedAccess, IndexedTypedAccess, Map<String,Object>, IAdaptable

Individual entry in a DominoCollection. Can have a type (data, category)

Author:

t.b.d

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CollectionEntry.SpecialValue

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
Optional<DocumentClass>	getDocumentClass() Retrieves the document class for the entry, if read.
int	getNoteID() Retrieves the note ID for the entry.
<T> T	getSpecialValue(CollectionEntry.SpecialValue value, Class<T> clazz, T defaultValue) Read meta data of the collection entry
String	getUNID() Retrieves the UNID associated with the entry, if it is a document.
boolean	isCategory() Determines whether the collection entry represents a category, as opposed to a document or total row.
boolean	isDocument() Determines whether the collection entry represents a document, as opposed to a category or total row.
Optional<Document>	openDocument() Open the database document for this collection entry

Methods inherited from interface com.hcl.domino.data.TypedAccess

get, getAsList, getItemNames, hasItem

Methods inherited from interface com.hcl.domino.data.IndexedTypedAccess

get, getAsList, getIndexedValueCount

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface com.hcl.domino.data.IAdaptable

getAdapter

Method Detail

getNoteID

int getNoteID()

Retrieves the note ID for the entry. This may be the ID of the document for a document row, or a special ID for a category row.

Returns:

the note ID value for the entry

getUNID

String getUNID()

Retrieves the UNID associated with the entry, if it is a document.

Returns:

the UNID of the entry's document, or an all-zero string if is not a document

isCategory

boolean isCategory()

Determines whether the collection entry represents a category, as opposed to a document or total row.

Returns:

true if the entry represents a category; false otherwise

isDocument

boolean isDocument()

Determines whether the collection entry represents a document, as opposed to a category or total row.

Returns:

true if the entry represents a document; false otherwise

getSpecialValue

<T> T getSpecialValue(CollectionEntry.SpecialValue value,
                      Class<T> clazz,
                      T defaultValue)

Read meta data of the collection entry

Type Parameters:

T - type of return value

Parameters:

value - special value to read

clazz - class of return value

defaultValue - default value if not available

Returns:

special value

openDocument

Optional<Document> openDocument()

Open the database document for this collection entry

Returns:

an Optional describing the document associated with this entry, or an empty one if the entry does not represent a document

getDocumentClass

Optional<DocumentClass> getDocumentClass()

Retrieves the document class for the entry, if read.

Returns:

a Optional describing this DocumentClass for the entry, or an empty one if that is not applicable