com.hcl.domino.data

Interface DominoCollection

All Superinterfaces:

DominoClientDescendant, IAdaptable

public interface DominoCollection
extends IAdaptable, DominoClientDescendant

Term borrowed from MongoDB. Covers Domino views/folders Collection Type (static = view) Contains CollectionEntry, Hibernate compliant

Author:

t.b.d

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DominoCollection.Direction Available column sort directions

Method Summary

Modifier and Type	Method and Description
void	forEachDocument(int skip, int count, BiConsumer<Document,Loop> consumer)
List<String>	getAliases()
Set<Integer>	getAllIds(boolean withDocuments, boolean withCategories) Returns an ordered set of note ids for collection entries that the current user is allowed to see.
IDTable	getAllIdsAsIDTable(boolean checkRights)
Set<Integer>	getAllIdsByKey(Set<Find> findFlags, Collection<Object> key) Returns an ordered set of note ids for collection entries that match the specified lookup key (supporting multi column lookups)
Set<Integer>	getAllIdsByKey(Set<Find> findFlags, Object key) Returns an ordered set of note ids for collection entries that match the specified lookup key
List<CollectionColumn>	getColumns()
int	getDocumentCount()
DominoDateTime	getLastAccessedTime() Returns the DominoDateTime when this view was last accessed
String	getName()
DominoDateTime	getNextDiscardTime() Returns the DominoDateTime when the view index will be discarded
int	getNoteId()
Database	getParentDatabase()
String	getSelectionFormula()
int	getTopLevelEntries()
String	getUNID()
boolean	isFolder()
CollectionSearchQuery	query()
void	refresh()
void	resetViewSortingToDefault()
void	resortView(String progColumnName, DominoCollection.Direction direction)

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

getAdapter

Methods inherited from interface com.hcl.domino.misc.DominoClientDescendant

getParentDominoClient

Method Detail

getParentDatabase

Database getParentDatabase()

getName

String getName()

getAliases

List<String> getAliases()

getUNID

String getUNID()

getNoteId

int getNoteId()

getSelectionFormula

String getSelectionFormula()

getAllIdsAsIDTable

IDTable getAllIdsAsIDTable(boolean checkRights)

getAllIds

Set<Integer> getAllIds(boolean withDocuments,
                       boolean withCategories)

Returns an ordered set of note ids for collection entries that the current user is allowed to see.

Implementations are likely, but not guaranteed, to return a LinkedHashSet.

Parameters:

withDocuments - true to return document note ids

withCategories - true to return category note ids

Returns:

sorted set of note ids

getAllIdsByKey

Set<Integer> getAllIdsByKey(Set<Find> findFlags,
                            Object key)

Returns an ordered set of note ids for collection entries that match the specified lookup key

Implementations are likely, but not guaranteed, to return a LinkedHashSet.

Parameters:

findFlags - flags to configure the lookup operation

key - lookup key (String, Number, DominoDateRange)

Returns:

sorted set of note ids

getAllIdsByKey

Set<Integer> getAllIdsByKey(Set<Find> findFlags,
                            Collection<Object> key)

Returns an ordered set of note ids for collection entries that match the specified lookup key (supporting multi column lookups)

Implementations are likely, but not guaranteed, to return a LinkedHashSet.

Parameters:

findFlags - flags to configure the lookup operation

key - lookup key (list of String, Number, DominoDateRange)

Returns:

sorted set of note ids

forEachDocument

void forEachDocument(int skip,
                     int count,
                     BiConsumer<Document,Loop> consumer)

getColumns

List<CollectionColumn> getColumns()

refresh

void refresh()

getTopLevelEntries

int getTopLevelEntries()

getDocumentCount

int getDocumentCount()

resetViewSortingToDefault

void resetViewSortingToDefault()

resortView

void resortView(String progColumnName,
                DominoCollection.Direction direction)

isFolder

boolean isFolder()

getLastAccessedTime

DominoDateTime getLastAccessedTime()

Returns the DominoDateTime when this view was last accessed

Returns:

last access date/time

getNextDiscardTime

DominoDateTime getNextDiscardTime()

Returns the DominoDateTime when the view index will be discarded

Returns:

discard date/time

query

CollectionSearchQuery query()