contains method

Indicates whether or not a DocumentCollection contains all of the given Documents or all of the Documents associated with the given ViewEntries.

Note: This method is new with Release 8.0.1.

Defined in

DocumentCollection

Syntax

public boolean contains(int noteID)
    throws NotesException
public boolean contains(Document document)
    throws NotesException
public boolean contains(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.

Legal values

  • true if this DocumentCollection contains the document or documents specified by the input argument
  • false if this DocumentCollection does not contain the document or documents specified by the input argument

Usage

The document or documents whose containment this method determines 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.

If collection is an empty document collection, this method will return True.