getDocumentByKey (View - Java™)

Finds a document based on its 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 the first document with column values that match the keys.

Defined in

View

Syntax

public Document getDocumentByKey(java.util.Vector keys)
    throws NotesException
public Document getDocumentByKey(Object key)
    throws NotesException
public Document getDocumentByKey(java.util.Vector keys, boolean exact)
    throws NotesException
public Document getDocumentByKey(Object key, boolean exact)
    throws NotesException

Parameters

java.util.Vector keys

String, Number, DateTime, or DateRange objects that are compared to sorted columns in the view. The first element in the vector is compared to the first sorted column in the view; the second element is compared to the second sorted column; and so on.

Object key

A String, Number, DateTime, or DateRange object that is compared to the first sorted column in the view.

boolean exact

Specify true if you want to find an exact match. If you specify false or omit this parameter, a partial match succeeds.

Return value

Document

The first document in the view with column values that match the keys. Returns null if there are no matching documents.

Usage

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

This method returns only the first document with column values that match the strings you indicate. To locate all matching documents, use getAllDocumentsByKey.

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."

If any columns are formatted with both categories and subcategories in the same column (using the "\\" special character), the method will not find the document.

To get view entry information about the document, use the getEntryByKey method.

Example