JAVA/CORBA CLASSES


getAllDocumentsByKey method
Example

Finds documents based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all documents whose column values match the keys.

Defined in

View

Syntax

public DocumentCollection getAllDocumentsByKey(java.util.Vector keys)
   throws NotesException

public DocumentCollection getAllDocumentsByKey(Object key)
   throws NotesException

public DocumentCollection getAllDocumentsByKey(java.util.Vector keys, boolean exact)
   throws NotesException

public DocumentCollection getAllDocumentsByKey(Object key, boolean exact)
   throws NotesException

Parameters

java.util.Vector keys


Object key
boolean exact
Return value

DocumentCollection


Usage

For the getAllDocumentsByKey method to work using a key, you must have at least one column sorted for every key in the vector.

This method returns all the documents whose column values match the keys. To locate just the first document, use getDocumentByKey.

Documents returned by this method are in no particular order, and do not provide access to column values. Use getAllEntriesByKey for these capabilities.

Matches are not case-sensitive. For example, "Turban" matches "turban." In an exact match, "cat" matches "cat" but does not match "category," while "20" matches "20" but does not match "201." In a partial match, "T" matches "Tim" or "turkey," but does not match "attic," while "cat" matches "catalog" or "category," but does not match "coat" or "bobcat."

The use of partial matches with multiple keys may result in missed documents. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, documents that fall out of sequence are missed.

To get view entry information about the documents, use the getAllEntriesByKey method.

Language cross-reference

GetAllDocumentsByKey method in LotusScript NotesView class

Example
See Also