文書の検索条件を指定すると、データベース内の次の文書を返します。

• 現在のエージェントが未処理とみなす文書
• 条件を満たす文書
• 切り離し日以降に作成または変更された文書。

定義位置

NotesDatabase

構文

Set notesDocumentCollection = notesDatabase.UnprocessedSearch( formula$, notesDateTime, maxDocs% )

パラメータ

formula$

String 型。検索条件を定義する Lotus Notes の @関数式です。

切り離し日。メソッドは切り離し日以降に作成または変更された文書だけを検索します。

Integer 型。返される文書の最大数です。このパラメータに 0 を設定すると一致した文書すべてを取得します。

notesDocumentCollection

NotesDocumentCollection。未読文書、選択条件に一致した文書、切り離し日以降に作成または変更された文書のコレクションを返します。コレクションは最も適合性の高い文書から順にソートされます。

このメソッドはエージェントまたはビューアクションスクリプトに対してのみ有効で、NotesSession の CurrentDatabase プロパティから取得した NotesDatabase オブジェクトだけで起動できます。エージェントまたはビューアクションに含まれないスクリプトでは、このメソッドは文書が 1 つも入っていない NotesDocumentCollection を返します。CurrentDatabase プロパティから取得されていない NotesDatabase オブジェクトで呼び出されたときは、このメソッドはエラーとなります。

動作

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

• まず、エージェントまたはビューアクションが「未処理」とみなす文書のコレクションを検索します。どの文書が未処理とみなされるかは、エージェントまたはビューアクションのタイプによって決まります。この文書コレクションは、UnprocessedDocuments プロパティで返されたコレクションと同一です。
• 次に、未処理文書に対して検索を実行し、検索条件に一致した文書と切り離し日以降に作成または変更された文書のコレクションを返します。

返される文書

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

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

UpdateProcessedDoc の使い方

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

UpdateProcessedDoc が処理済みのマークを付けるのは、このメソッドの呼び出し元の特定のエージェントが処理した文書だけです。あるエージェントで UpdateProcessedDoc を使用しても、他のエージェントが処理する文書には影響がありません。

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

ビューアクション

ビューアクションで使用されるとき、UnprocessedSearch は選択文書で実行されるエージェントの場合と同じ文書を返します。

クロスリファレンス

Java AgentContext クラスの unprocessedSearch メソッド

式言語の EditSelectByDate @コマンド

例
関連項目

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

用語集