読み込み専用。 データベース内にある文書で、現在のエージェントが「未処理」であるとみなす文書。 どの文書が未処理であるとみなされるかは、エージェントの種類によって決まります。
public DocumentCollection getUnprocessedDocuments()
throws NotesExceptionこのメソッドはエージェントだけに有効です。
次の表では、getUnprocessedDocuments によって返される文書について説明します。 エージェントを実行する前に文書が 1 回選択されます。
| エージェントの実行対象 |
UnprocessedDocuments によって返される文書がすべて満たす要件 |
|---|---|
| データベースのすべての文書 |
[エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| 作成または変更されたすべての文書 |
このエージェントが updateProcessedDoc を使用して処理していないこと エージェントが最後に実行されてから新規作成または更新されていること [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| ビューのすべての未読文書 |
ビューにある未読文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| ビューのすべての文書 |
ビューにある文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| 選択されたすべての文書 |
ビューで選択されている文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| なし |
現在の文書のみ |
| 新規メールを受信する前にトリガーします。 |
なし (まったく文書を戻さない。代わりに AgentContext に DocumentContext を使用する) |
| 新規メールを受信した後にトリガーします。 |
エージェントの最終実行後にデータベースに送信されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| 新規に更新された文書 |
エージェントの最終実行後に更新されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
| 追加された文書 |
エージェントの最終実行後にデータベースに追加されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと |
新規文書または変更文書を対象に実行されるエージェントの場合は、Session の updateProcessedDoc を使用して、各文書に「処理しました」というマークを付ける必要があります。これにより、(文書を再度変更しない限り) 文書がエージェントによって処理される回数は確実に 1 回のみになります。 このメソッドを文書ごとに呼び出さないと、エージェントは次回の実行時にも同じ文書を処理します。
updateProcessedDoc メソッドでは、文書の呼び出し元である特定のエージェントの場合にのみ、文書にマークが付けられます。 あるエージェントで updateProcessedDoc を使用しても、他のエージェントが処理する文書には影響はありません。