Conducts a full-text search on all entries in a view entry collection and filters the collection so that it respresents only the entries that match the full-text query.

Defined in

ViewEntryCollection

Syntax

public void FTSearch(String query)
   throws NotesException

public void FTSearch(String query, int maxdocs)
   throws NotesException

Parameters

String query

The full-text query. See the syntax section that follows.

The maximum number of documents you want returned from the query. Set this parameter to 0 to receive all matching documents.

The collection of entries that match the full-text query are sorted by relevance with highest relevance first. You can access the relevance score of each entry in the collection with getFTSearchScore in ViewEntry.

If the database is not full-text indexed, this method works, but less efficiently. To test for an index, use isFTIndexed in Database. To create an index on a local database, use updateFTIndex in Database.

The current pointer is reset to the first document in the collection.

Query syntax

To search for a word or phrase, enter the word or phrase as is, except that search keywords must be enclosed in quotes. Remember to escape quotes if you are inside a literal.

Wildcards, operators, and other syntax are permitted. For the complete syntax rules, see "Refining a search query using operators" in Lotus Notes Help. Search for "query syntax" in the Domino Designer Eclipse help system or information center (for example, http://publib.boulder.ibm.com/infocenter/domhelp/v8r0/index.jsp), both of which include Lotus Notes.

Language cross-reference

FTSearch method in LotusScript NotesViewEntryCollection class

Example
See Also

Working with view entries and navigators

Glossary