ビューの列の値を使用して文書を検索します。ユーザーはキーまたはキーのベクトルを作成します。各キーはビュー内のソートした列の値に対応します。このメソッドは、キーの値と一致する列値を持つ最初の文書を返します。

定義位置

View

構文

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

パラメータ

java.util.Vector keys

ビュー内のソート済みの列と比較される String、Number、DateTime、または DateRange オブジェクトです。ベクトルの最初の要素は、ビュー内の最初のソートされた列と比較され、2 番目の要素は 2 番目にソートされた列と比較される、というように列と対応します。

ビュー内の最初のソート済み列と比較される String、Number、DateTime、または DateRange オブジェクトです。

完全に一致するものを検索する場合は true を指定します。false を指定するかこのパラメータを省略すると、部分的に一致するものも検索されます。

文書

キーと一致する列値を持つ、ビュー内で最初の文書を返します。一致する文書がない場合は null を返します。

キーを使用して getDocumentByKey メソッドを使用するには、ベクトル内のキーごとに少なくとも 1 列はソートしておく必要があります。

このメソッドは、指定した文字列と一致する列値を持つ最初の文書だけを返します。一致する文書をすべて検索するには、getAllDocumentsByKey を使用します。

大文字と小文字は区別されません。たとえば、「Turban」は「turban」と一致します。完全一致の場合、「cat」は「cat」とのみ一致し、「category」とは一致しません。また、「20」は「20」とのみ一致し、「201」とは一致しません。部分一致では、「T」が「Tim」や「turkey」とも一致し、「attic」とは一致しません。「cat」は「catalog」や「category」とも一致し、「coat」や「bobcat」とは一致しません。

文書のビューエントリ情報を取り出すには、getEntryByKey メソッドを使用します。

クロスリファレンス

LotusScript NotesView クラスの GetDocumentByKey メソッド

式言語の FileOpenDatabase @コマンド

例
関連項目

ビューのエントリやナビゲータを処理する

用語集