LOTUSSCRIPT/COM/OLE CLASSES


UnprocessedSearch method
Example

Given selection criteria for a document, returns documents in a database that:


Note This method is not implemented in COM.

Defined in

NotesDatabase

Syntax

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

Parameters

formula$


notesDateTime
maxDocs%
Return value

notesDocumentCollection


Usage

This method is valid only for agent or view action scripts, and may be invoked only on NotesDatabase objects obtained from the CurrentDatabase property in NotesSession. In scripts that are not a part of an agent or view action, this method returns a NotesDocumentCollection with zero documents. When invoked on a NotesDatabase object that was not obtained from the CurrentDatabase property, this method raises an error.

How does it work?

This method works in two parts:


For example, in an agent that runs on all selected documents in the view, UnprocessedSearch searches only the selected documents and returns those that match the selection criteria. In an agent that runs on documents that have been created or modified since last run, UnprocessedSearch searches only the documents that have not been marked by the UpdateProcessedDoc method in NotesSession, and returns those that match the selection criteria.

What documents are returned?

The following table describes the documents that are returned by the UnprocessedSearch method. Document selection occurs once, before the agent runs.
Agent runs onUnprocessedSearch returns documents that meet all of these requirements
All documents in databaseMeet the search criteria specified in Agent Properties box

Meet the @function search criteria specified in this method

All new & modified documentsNot processed by this agent with UpdateProcessedDoc

Created or modified since the agent last ran

Meet the search criteria specified in Agent Properties box

Meet the @function search criteria specified in this method

All unread documents in viewAre unread and in the view

Meet the search criteria specified in Agent Properties box

Meet the @function search criteria specified in this method

All documents in viewAre in the view

Meet the search criteria specified in Agent Properties box

Meet the @function search criteria specified in this method

All selected documents

or

View action

Are selected in the view

Meet the search criteria specified in Agent Properties box

Meet the @function search criteria specified in this method

NoneIs the current document only
Newly received mail documentsMailed to the database since the agent last ran

Meet the search criteria specified in Agent Properties box

Meet the @function search criteria specified in this method

Newly modified documentsModified since the agent last ran

Meet the search criteria specified in Agent Properties box

Meet the @function search criteria specified in this method

Pasted documentsPasted into the database since the agent last ran

Meet the search criteria specified in Agent Properties box

Meet the @function search criteria specified in this method


Using UpdateProcessedDoc

For agents that run on new and modified documents, newly received mail documents, pasted documents, or newly modified documents, you must use the UpdateProcessedDoc method in NotesSession to mark each document as "processed," which ensures that a document gets processed by the agent only once (unless it's modified, mailed, or pasted again). If you do not call this method for each document, the agent processes the same documents the next time it runs.

UpdateProcessedDoc marks a document as processed only for the particular agent from which it is called. Using UpdateProcessedDoc in one agent has no effect on the documents that another agent processes.

In all other agents and view actions, UpdateProcessedDoc has no effect.

View actions

When used in a view action, UnprocessedSearch returns the same documents as an agent that runs on selected documents.

Language cross-reference

unprocessedSearch method in Java AgentContext class

EditSelectByDate @command function in formula language

Example
See Also