contains (ViewEntryCollection - Java™)

Indicates whether or not a ViewEntryCollection contains all of the Documents or ViewEntries given.

Note: This method is new with Release 8.0.1.

Defined in

ViewEntryCollection

Syntax

public boolean viewEntryCollection.contains(int noteID)
    throws NotesException
public boolean viewEntryCollection.contains(Document doc)
    throws NotesException
public boolean viewEntryCollection.contains(DocumentCollection dcol)
    throws NotesException
public boolean viewEntryCollection.contains(ViewEntry ventry)
    throws NotesException
public boolean viewEntryCollection.contains(ViewEntryCollection vec)
    throws NotesException

Parameters

int noteID

A single notedID, belonging to this ViewEntryCollection's database.

Document doc

A single document, belonging to this ViewEntryCollection's database.

DocumentCollection dcol

A document collection, belonging to this ViewEntryCollection's database.

ViewEntry ventry

A single view entry, belonging to this ViewEntryCollection's database, that has a Document associated with it.

ViewEntryCollection vec

A view entry collection, belonging to this ViewEntryCollection's database, all of which have Documents associated with them.

Return values

  • True indicates that all of the documents are contained in the original collection
  • False indicates that one or more of the documents are not contained in the original collection

Usage

The document or documents whose containment this method determines (or the view entries associated with those documents) 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 the dcol or vec parameter is an empty collection, this method will return True.