JAVA/CORBA CLASSES


getAllEntriesByKey method
Example

Finds view entries of type document 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 entries whose column values match the keys.

Defined in

View

Syntax

public ViewEntryCollection getAllEntriesByKey(java.util.Vector keys)
   throws NotesException

public ViewEntryCollection getAllEntriesByKey(Object key)
   throws NotesException

public ViewEntryCollection getAllEntriesByKey(java.util.Vector keys, boolean exact)
   throws NotesException

public ViewEntryCollection getAllEntriesByKey(Object key, boolean exact)
   throws NotesException

Parameters

java.util.Vector keys


Object key
boolean exact
Return value

ViewEntryCollection


Usage

For the getAllEntriesByKey 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 view entries of type document whose column values match the keys. To locate just the first entry, use getEntryByKey.

Entries returned by this method are in view order and provide access to column values.

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 entries. If the first key is partial and the second column does not sort the same with the partial key as with the exact key, entries that fall out of sequence are missed.

This method is similar to getAllDocumentsByKey.

Language cross-reference

GetAllEntriesByKey method in LotusScript NotesView class

Example
See Also