intersect (DocumentCollection - Java)

Removes from a document collection any documents not also contained in a second collection.

Note: This method is new with Release 8.0.1.

Defined in

DocumentCollection

Syntax

public void intersect(int noteID)
    throws NotesException
public void intersect(Document document)
    throws NotesException
public void intersect(DocumentCollection collection)
    throws NotesException

Parameters

int noteID

A single noteID belonging to the DocumentCollection's database.

Document document

A single document belonging to the DocumentCollection's database.

DocumentCollection collection

A documentCollection, all documents of which must belong to the DocumentCollection's database.

Usage

The document or documents being intersected by this method must be in the same database as the original collection. Otherwise, the method will return the error "the specified note or notes do not exist in the database" or, if a noteID was passed to the method that matches a noteID in the original collection's database, the method will use the unintended document.

On successful completion of this method, the original document collection will contain only the documents it contained prior to the call which are also contained in the input argument.