LOTUSSCRIPT/COM/OLE CLASSES
NotesDocumentCollection class
Example

Represents a collection of documents from a database, selected according to specific criteria.

Containment

Contained by: NotesDatabase, NotesSession, NotesUIDatabase, NotesUIView

Contains: NotesDocument

Properties

Count

IsSorted

Parent

Query

Methods

AddDocument

DeleteDocument

FTSearch

GetDocument

GetFirstDocument

GetLastDocument

GetNextDocument

GetNthDocument

GetPrevDocument

PutAllInFolder

RemoveAll

RemoveAllFromFolder

StampAll

UpdateAll

Access

A NotesDocumentCollection represents a subset of all the documents in a database. The documents in the subset are determined by the NotesDatabase method or property you use to search the database, which can be any of the following:


The Responses property in NotesDocument also returns a NotesDocumentCollection.

Usage

Both NotesDocumentCollection and NotesView objects provide access to documents within a database. Use a NotesDocumentCollection object if:


Views are a more efficient means of accessing documents because they are already indexed by the database itself. However, they do not necessarily provide access to the documents that you want.

Ordering of documents

The documents in a collection are ordered when the collection results from a full-text search; otherwise, the documents are unordered.

Current pointer

A current pointer is maintained for document collections. All navigation methods set the current pointer to the retrieved document with the following exceptions. Add and delete methods do not move the current pointer. The following methods set the current pointer to the first document: FTSearch, RemoveAll (remote IIOP only), PutAllInFolder, RemoveAllFromFolder, and StampAll.

Deletion stubs

A deletion stub is returned for a document deleted after creation of the collection or for a document to which you do not have read access. Use IsValid in NotesDocument to check whether a document is real (True) or a deletion stub (False).

Example
See Also