subtract (ViewEntryCollection - Java™)

Removes from a view entry collection any entries whose associated documents are also contained in a second collection.

Note: This method is new with Release 8.0.1.

Defined in

ViewEntryCollection

Syntax

public void viewEntryCollection.subtract(int noteID)
    throws NotesException
public void viewEntryCollection.subtract(Document doc)
    throws NotesException
public void viewEntryCollection.subtract(DocumentCollection dcol)
    throws NotesException
public void viewEntryCollection.subtract(ViewEntry ventry)
    throws NotesException
public void viewEntryCollection.subtract(ViewEntryCollection vec, boolean maintainOrder)
    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.

boolean maintainOrder

When set, after the Subtract call, the order of entries in the ViewEntryCollection will be that of that of the view from which it was created. That is, the order will either be the default order of the View or that last set by calling ResortView.

Usage

The document or documents (or the view entries and their associated documents) being subtracted 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.