com.hcl.domino.data

Interface DocumentSelection

All Superinterfaces:

Collection<Integer>, DominoClientDescendant, IAdaptable, IDTable, Iterable<Integer>, Set<Integer>

public interface DocumentSelection
extends IDTable, DominoClientDescendant

Subclass of IDTable to select data, design or admin documents from an NSF.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DocumentSelection.SelectionType The available document types that can be selected via select(Collection) and select(SelectionType...).

Field Summary

Fields inherited from interface com.hcl.domino.data.IDTable

NOTEID_FLAG_DELETED

Method Summary

Modifier and Type	Method and Description
DocumentSelection	build() Runs a database search, adding note ids of search matches to this object (subclass of IDTable).
DocumentSelection	deselect(Collection<DocumentSelection.SelectionType> selectionTypes) Removes content types from the selection
DocumentSelection	deselect(DocumentSelection.SelectionType... selectionTypes) Removes content types from the selection
Optional<DominoDateTime>	getLastBuildTime() Returns the last time, the build() has been invoked.
Database	getParentDatabase() Returns the parent database
Optional<IDTable>	getPreselection() Returns an IDTable with note ids to pre-filter the documents to be scanned by the search
Set<DocumentSelection.SelectionType>	getSelection() Returns the currently selected content types
String	getSelectionFormula() Returns the selection formula to selects notes for inclusion in the collection.
Optional<DominoDateTime>	getSinceTime() Returns the since time so that the search only contains documents with a "Modified in this file" date after the given date.
Optional<DominoDateTime>	getUntilTime() Returns a date that can be passed as "since time" to the next search for incremental searches.
boolean	isSelected(DocumentSelection.SelectionType selectionType) Checks if a content type is selected
DocumentSelection	select(Collection<DocumentSelection.SelectionType> selectionTypes) Adds content types to the selection
DocumentSelection	select(DocumentSelection.SelectionType... selectionTypes) Adds content types to the selection
DocumentSelection	selectAllAdminDocuments() Selects replication formulas and ACLs
DocumentSelection	selectAllCodeElements() Selects agents, outlines, database script, script libraries, data connections and misc code elements.
DocumentSelection	selectAllDataDocuments() Selects normal data documents and profiles
DocumentSelection	selectAllDesignElements() Selects format, index and code elements, the icon, shared fields, help about, help using and help imdex.
DocumentSelection	selectAllDocuments() Selects data, admin and design documents
DocumentSelection	selectAllFormatElements() Selects forms, subforms, actions, framesets, pages, image resources, stylesheets, Java resources and misc format elements.
DocumentSelection	selectAllIndexElements() Selects views, folders, navigators and misc index elements
DocumentSelection	withPreselection(Collection<Integer> noteIds) Use this method to pre-filter the documents to be scanned by the search
DocumentSelection	withSelectionFormula(String formula) Sets a formula that selects notes for inclusion in the collection.
DocumentSelection	withSinceTime(Temporal dt) Adds a since time to the search so that it only contains documents with a "Modified in this file" date after the given date.

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

clone, getDateTime, intersect, isInverted, isModified, reverseIterator, setDateTime, setInverted, setModified, toIntArray

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

getAdapter

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

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

getParentDominoClient

Method Detail

getParentDatabase

Database getParentDatabase()

Returns the parent database

Returns:

database

select

DocumentSelection select(DocumentSelection.SelectionType... selectionTypes)

Adds content types to the selection

Parameters:

selectionTypes - content types

Returns:

document selection instance

select

DocumentSelection select(Collection<DocumentSelection.SelectionType> selectionTypes)

Adds content types to the selection

Parameters:

selectionTypes - content types

Returns:

document selection instance

selectAllDocuments

DocumentSelection selectAllDocuments()

Selects data, admin and design documents

Returns:

document selection instance

selectAllDataDocuments

DocumentSelection selectAllDataDocuments()

Selects normal data documents and profiles

Returns:

document selection instance

selectAllAdminDocuments

DocumentSelection selectAllAdminDocuments()

Selects replication formulas and ACLs

Returns:

document selection instance

selectAllDesignElements

DocumentSelection selectAllDesignElements()

Selects format, index and code elements, the icon, shared fields, help about, help using and help imdex.

Returns:

document selection instance

selectAllFormatElements

DocumentSelection selectAllFormatElements()

Selects forms, subforms, actions, framesets, pages, image resources, stylesheets, Java resources and misc format elements.

Returns:

document selection instance

selectAllIndexElements

DocumentSelection selectAllIndexElements()

Selects views, folders, navigators and misc index elements

Returns:

document selection instance

selectAllCodeElements

DocumentSelection selectAllCodeElements()

Selects agents, outlines, database script, script libraries, data connections and misc code elements.

Returns:

document selection instance

deselect

DocumentSelection deselect(DocumentSelection.SelectionType... selectionTypes)

Removes content types from the selection

Parameters:

selectionTypes - content types

Returns:

document selection instance

deselect

DocumentSelection deselect(Collection<DocumentSelection.SelectionType> selectionTypes)

Removes content types from the selection

Parameters:

selectionTypes - content types

Returns:

document selection instance

isSelected

boolean isSelected(DocumentSelection.SelectionType selectionType)

Checks if a content type is selected

Parameters:

selectionType - content type

Returns:

true if selected

getSelection

Set<DocumentSelection.SelectionType> getSelection()

Returns the currently selected content types

Returns:

selection

withSelectionFormula

DocumentSelection withSelectionFormula(String formula)

Sets a formula that selects notes for inclusion in the collection.

Parameters:

formula - formula

Returns:

document selection instance

getSelectionFormula

String getSelectionFormula()

Returns the selection formula to selects notes for inclusion in the collection.

Returns:

the selection formula or an empty string if no selection formula was set

withPreselection

DocumentSelection withPreselection(Collection<Integer> noteIds)

Use this method to pre-filter the documents to be scanned by the search

Parameters:

noteIds - note ids

Returns:

document selection instance

getPreselection

Optional<IDTable> getPreselection()

Returns an IDTable with note ids to pre-filter the documents to be scanned by the search

Returns:

an Optional describing the pre-selected documents, or an empty one if this has not been set

withSinceTime

DocumentSelection withSinceTime(Temporal dt)

Adds a since time to the search so that it only contains documents with a "Modified in this file" date after the given date.

Parameters:

dt - since time

Returns:

document selection instance

getSinceTime

Optional<DominoDateTime> getSinceTime()

Returns the since time so that the search only contains documents with a "Modified in this file" date after the given date.

Returns:

an Optional describing the since time, or an empty one if this has not been set

getUntilTime

Optional<DominoDateTime> getUntilTime()

Returns a date that can be passed as "since time" to the next search for incremental searches.

Returns:

an Optional describing the until time, or an empty one if build() has not yet been called

getLastBuildTime

Optional<DominoDateTime> getLastBuildTime()

Returns the last time, the build() has been invoked.

Returns:

an Optional describing the build time, or an empty one if build() has not yet been called

build

DocumentSelection build()

Runs a database search, adding note ids of search matches to this object (subclass of IDTable).

Returns:

document selection instance