選択条件が指定されると、データベース内の次の文書を返します。
public DocumentCollection unprocessedSearch(String formula, DateTime limit, int maxdocs)
throws NotesExceptionString formula選択条件を定義する Domino の式です。
DateTime limit切り離し日。
int maxdocs返す文書の最大数。0 を指定すると、一致するすべての文書という意味になります。
DocumentCollection未処理で、選択基準に一致し、かつ切り離し日以降に作成または変更された一連の文書。コレクションは、適合スコアを使用して適合性の高い順にソートされます。
このメソッドはエージェントだけに有効です。
このメソッドは次の 2 段階で動作します。
例えば、ビュー内のすべての選択文書を対象に実行されるエージェントの場合、unprocessedSearch は選択された文書のみを検索し、選択基準に一致する文書を返します。 前回の実行以降に変更されたすべての文書とすべての新規文書を対象に実行されるエージェントの場合、unprocessedSearch は、updateProcessedDoc によってマークが付けられなかった文書のみを検索し、選択基準に一致する文書を返します。
次の表では、unprocessedSearch によって返される文書について説明します。 エージェントを実行する前に文書が 1 回選択されます。
| エージェントの実行対象 |
unprocessedSearch によって返される文書が満たすべき要件 |
|---|---|
| データベースのすべての文書 |
[エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された式検索条件に一致すること このメソッドで指定された切り離し日に一致すること |
| 作成または変更されたすべての文書 |
このエージェントが updateProcessedDoc を使用して処理していないこと エージェントが最後に実行されてから新規作成または更新されていること [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された式検索条件に一致すること このメソッドで指定された切り離し日に一致すること |
| ビューのすべての未読文書 |
ビューにある未読文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された式検索条件に一致すること このメソッドで指定された切り離し日に一致すること |
| ビューのすべての文書 |
ビューにある文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された式検索条件に一致すること このメソッドで指定された切り離し日に一致すること |
| 選択されたすべての文書 |
ビューで選択されている文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された式検索条件に一致すること このメソッドで指定された切り離し日に一致すること |
| なし |
現在の文書のみ |
新規文書または変更文書を対象に実行されるエージェントの場合は、updateProcessedDoc を使用して、各文書に処理済みのマークを付ける必要があります。これにより、(文書を再度変更しない限り) 文書がエージェントによって処理される回数は確実に 1 回のみになります。 このメソッドを文書ごとに呼び出さないと、エージェントは次回の実行時にも同じ文書を処理します。
updateProcessedDoc メソッドでは、文書の呼び出し元である特定のエージェントの場合にのみ、文書にマークが付けられます。 あるエージェントで updateProcessedDoc を使用しても、他のエージェントが処理する文書には影響はありません。
その他のすべてのエージェントとビューアクションでは、UpdateProcessedDoc による影響はありません。