現在のエージェントが未処理と判断するデータベース内の文書を全文検索します。

メモ このメソッドは COM では実装されていません。

定義位置NotesDatabase
構文Set notesDocumentCollection = notesDatabase.UnprocessedFTSearch(query$, maxdocs%, [ sortoptions% ], [ otheroptions% ] )
パラメータquery$

String 型。全文検索の検索条件です。

Integer 型。検索で取得する文書数の最大値です。このパラメータを 0 に設定すると、検索条件に合うすべての文書 (最大 5,000 まで。下の「全文索引」セクションを参照。) を取得します。

Integer 型。省略可能。ソートオプションです。次のいずれかを選択します。
• FT_DATE_ASC (64) は、文書の日付の昇順にソートします。
• FT_DATE_DES (32) は、文書の日付の降順にソートします。
• FT_DATECREATED_ASC (1543) は、文書作成日の昇順にソートします。
• FT_DATECREATED_DES (1542) は、文書作成日の降順にソートします。
• FT_SCORES (8) は、適合スコアでソートします (デフォルト)。

Integer 型。省略可能。検索オプションです。オプションは、追加して組み合わせます。
• FT_DATABASE (8192) を指定すると、Lotus Domino データベースを含んで検索します。
• FT_FUZZY (16384) を指定すると、関連語が検索されます。完全一致である必要はありません。
• FT_FILESYSTEM (4096) を指定すると、Lotus Domino データベースではないファイルを含んで検索します。
• FT_STEMS (512) を指定すると、検索の基本として語幹が使われます。
• FT_THESAURUS (1024) を指定すると、類義語を使用して検索します。

NotesDocumentCollection。選択したオプションによりソートされた、全文検索条件に一致した未処理文書のコレクションを返します。

動作このメソッドは次の 2 段階で動作します。

• まず、メソッドはエージェントが「未処理である」と判断する文書のコレクションを検索します。どの文書が未処理とみなされるかは、エージェントまたはビューアクションのタイプによって決まります。この文書コレクションは、UnprocessedDocuments プロパティで返されたコレクションと同一です。
• 次に、メソッドは未処理文書を全文検索して、検索条件と一致する文書のコレクションを返します。

返される文書次の表は UnprocessedFTSearch メソッドが返す文書を示します。エージェントを実行する前に文書が 1 回選択されます。

エージェントの実行対象	UnprocessedFTSearch によって返される文書が満たさなければならないすべての条件
データベースのすべての文書	[エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された全文検索の条件を満たすこと
すべての新規作成または更新された文書	このエージェントが UpdateProcessedDoc で処理していないこと エージェントが最後に実行されてから新規作成または更新されていること [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された全文検索の条件を満たすこと
ビューのすべての未読文書	ビューにある未読文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された全文検索の条件を満たすこと
ビューのすべての文書	ビューにある文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された全文検索の条件を満たすこと
選択されたすべての文書 または ビューアクション	ビューで選択されている文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された全文検索の条件を満たすこと
1 回の実行	現在の文書
新規に受信したメール文書	このエージェントが UpdateProcessedDoc で処理していないこと エージェントの最終実行後にデータベースに送信されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された全文検索の条件を満たすこと
新規に更新された文書	このエージェントが UpdateProcessedDoc で処理していないこと エージェントの最終実行後に更新されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された全文検索の条件を満たすこと
追加された文書	このエージェントが UpdateProcessedDoc で処理していないこと エージェントの最終実行後にデータベースに追加されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された全文検索の条件を満たすこと

UpdateProcessedDoc の使い方新規作成および変更された文書、新規に受信したメール文書、新規に追加された文書、新規に変更された文書で実行されるエージェントの場合、NotesSession の UpdateProcessedDoc メソッドを使って、各文書を「処理済み」にします。「処理済み」にすると、再び変更、メール送信、追加をされないかぎり、エージェントはその文書を処理しません。各文書についてこのメソッドを呼び出さないときは、エージェントは次の実行で同じ文書を処理してしまいます。
UpdateProcessedDoc が処理済みのマークを付けるのは、このメソッドの呼び出し元の特定のエージェントが処理した文書だけです。あるエージェントで UpdateProcessedDoc を使っても、他のエージェントが処理する文書には影響がありません。

UpdateProcessedDoc は他のすべてのエージェントとビューアクションに影響を与えません。

ビューアクションビューアクションで使われるとき、UnprocessedFTSearch は選択文書で実行されるエージェントの場合と同じ文書を返します。
全文索引データベースに全文索引が作成されていなくてもこのメソッドは動作しますが、処理効率は低下します。索引があるかどうかを調べるには NotesDatabase の IsFTIndexed プロパティを使います。全文索引が変更後に更新されていない場合、データベースの内容を完全には反映しません。ローカルデータベース上で索引の作成や更新を行うには、UpdateFTIndex メソッドを使います。
デフォルトでは、このメソッドは最大 5,000 件の文書を返します。索引付きのデータベースまたは索引は付いていないがクライアントのエージェントで実行されているデータベースの場合は、Notes.ini 変数 FT_MAX_SEARCH_RESULTS でこの制限を変更します。索引が付いておらず、サーバーのエージェントで実行されているデータベースの場合は、Notes.ini 変数 TEMP_INDEX_MAX_DOC も設定する必要があります。絶対的な最大値は 2,147,483,647 となります。

オプションソートオプションを何も指定しない場合は、文書は適合スコアでソートされます。コレクションは適合スコアでソートされ、適合性の一番高いものから順に配置されます。コレクションの各文書の適合スコアにアクセスするには、NotesDocument の FTSearchScore を使います。
日付順のソートを指定すると、適合スコアは取得できません。結果の DocumentCollection を NotesNewsletter オブジェクトへ渡す場合、文書リンクは使用したソートオプションに応じて文書作成日か適合スコアでフォーマットされます。

検索構文語句を検索するには語句をそのまま入力します。ただし、検索キーワードは引用符で囲む必要があります。リテラル内の二重引用符はエスケープ処理してください。
ワイルドカード、演算子、およびその他の検索構文も使用できます。構文規則については、『Lotus Notes ヘルプ』の「特定のテキストを含む文書をデータベースで検索する」を参照してください。

クロスリファレンスJava AgentContext クラスの unprocessedFTSearch メソッド
例
関連項目

LotusScript のクラスで検索によって文書を収集する

用語集