unprocessedSearch (NotesAgentContext - JavaScript)

選択基準が指定されると、データベース内の文書を返します。対象となる文書は、現在のエージェントが未処理であるとみなす文書、選択基準を満たす文書、削除日以降に作成または変更された文書です。

定義場所

NotesAgentContext

構文

unprocessedSearch(formula:string, limit:NotesDateTime, maxdocs:int) : NotesDocumentCollection
パラメータ 説明
String formula 選択基準を定義する Domino® の式。
DateTime limit 削除日。
int maxdocs 返す文書の最大数。0 を指定すると、一致するすべての文書という意味になります。
戻り値 説明
DocumentCollection 未処理で、選択基準に一致し、かつ切り離し日以降に作成または変更された一連の文書。一連の文書は関連性を基準にしてソートされ、関連性が最も高い文書が先頭になります。

使用法

このメソッドはエージェントに対してのみ有効です。

機能の仕組み

このメソッドは、以下の 2 段階で機能します。

例えば、ビュー内のすべての選択文書を対象に実行されるエージェントの場合、unprocessedSearch は選択された文書のみを検索し、選択基準に一致する文書を返します。 前回の実行以降に変更されたすべての文書とすべての新規文書を対象に実行されるエージェントの場合、unprocessedSearch は、updateProcessedDoc によってマークが付けられなかった文書のみを検索し、選択基準に一致する文書を返します。

返される文書の種類

次の表では、unprocessedSearch によって返される文書について説明します。 文書の選択は、エージェントを実行する前に 1 回行われます。

エージェントの実行対象または実行条件 unprocessedSearch によって返される文書が満たすべき要件
データベースのすべての文書
  • [エージェントのプロパティ] ボックスに指定した検索条件を満たす
  • このメソッドに指定した式の検索条件を満たす
  • このメソッドに指定した削除日の条件を満たす
作成または変更されたすべての文書
  • このエージェントと updateProcessedDoc の組み合わせでは処理されない
  • エージェントの前回の実行以降に作成または変更された
  • [エージェントのプロパティ] ボックスに指定した検索条件を満たす
  • このメソッドに指定した式の検索条件を満たす
  • このメソッドに指定した削除日の条件を満たす
ビューのすべての未読文書
  • 未読で、ビュー内にある
  • [エージェントのプロパティ] ボックスに指定した検索条件を満たす
  • このメソッドに指定した式の検索条件を満たす
  • このメソッドに指定した削除日の条件を満たす
ビューのすべての文書
  • ビュー内にある
  • [エージェントのプロパティ] ボックスに指定した検索条件を満たす
  • このメソッドに指定した式の検索条件を満たす
  • このメソッドに指定した削除日の条件を満たす
すべての選択文書
  • ビュー内で選択されている
  • [エージェントのプロパティ] ボックスに指定した検索条件を満たす
  • このメソッドに指定した式の検索条件を満たす
  • このメソッドに指定した削除日の条件を満たす
なし 現在の文書のみ updateProcessedDoc を使用

新規文書または変更文書を対象に実行されるエージェントの場合は、updateProcessedDoc を使用して、各文書に処理済みのマークを付ける必要があります。これにより、(文書を再度変更しない限り) 文書がエージェントによって処理される回数は確実に 1 回のみになります。 このメソッドを文書ごとに呼び出さないと、エージェントは次回の実行時にも同じ文書を処理します。

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

その他のすべてのエージェントとビューアクションでは、UpdateProcessedDoc による影響はありません。

言語間の参照

LotusScript® NotesDatabase クラスの UnprocessedSearch メソッド

Java™ Database クラスの unprocessedSearch メソッド

式言語の EditSelectByDate @コマンド関数