ビュー内の列の値に基づいて、その文書を検索します。 ユーザーはキーまたはキーのベクトルを作成し、それぞれのキーはビュー内のソートされた列の値に対応します。 このメソッドは、キーに一致する列の値がある最初の文書を返します。
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 オブジェクトです。ベクトルの 1 番目の要素はビューのソートされた最初の列と比較され、2 番目の要素はビューのソートされた 2 番目の列と比較されます。
Object key
ビュー内の最初のソート済み列と比較される String、Number、DateTime、または DateRange オブジェクトです。
boolean exact
完全一致で検索する場合は true を指定します。 false を指定するかこのパラメータを省略すると、部分的に一致するものも検索されます。
Document
キーに一致する列の値があるビュー内の最初の文書。 一致する文書がない場合は null を返します。
キーを使用して getDocumentByKey メソッドを使用するには、ベクトル内のキーごとに少なくとも 1 列はソートしておく必要があります。
このメソッドは、指定した文字列に一致する列の値がある最初の文書のみを返します。 一致するすべての文書を見つけるには、getAllDocumentsByKey を使用してください。
一致するアイテムの大文字、小文字は区別されません。 例えば、Turban は turban と一致します。 完全一致では、cat は cat と一致しますが、category とは一致しません。 また、20 は 20 と一致しますが、201 とは一致しません。 部分一致では、「T」が「Tim」や「turkey」とも一致し、「attic」とは一致しません。「cat」は「catalog」や「category」とも一致し、「coat」や「bobcat」とは一致しません。
同じ列内で (「¥¥」特殊文字を使用して) カテゴリとサブカテゴリの両方によってフォーマットされている列がある場合、このメソッドでは文書は検出されません。
文書のビューエントリ情報を取り出すには、getEntryByKey メソッドを使用します。