IBM Lotus Domino Designer 8.5
Versions 8.5 and 8.5.1

FTDomainSearch method

Conducts a Domain Search, that is, a full-text search of all databases configured in the Domain Catalog database and marked as included for multi-database indexing.

Note This method is new with Release 5.

Defined in

NotesDatabase

Syntax

Set notesDocument = notesDatabase.FTDomainSearch( query$, maxDocs%, [ sortoptions%], [ otheroptions%], [ start&], [ count%], [ entryform$ ] )

Parameters

query$

String. The full-text query.

maxDocs%

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

sortoptions%

Integer. Optional. Sorting options. Combine options by adding.

FT_DATE_ASC (64) sorts by document creation date in ascending order.
FT_DATE_DES (32) sorts by document creation date in descending order.
FT_SCORES (8) sorts by relevance score (default).

otheroptions%

Integer. Optional. Search options. Combine options by adding.

FT_DATABASE (8192) includes Domino databases.
FT_FUZZY (16384) searches for related words. Need not be an exact match.
FT_FILESYSTEM (4096) includes files that are not Domino databases.
FT_STEMS (512) uses stem words as the basis of the search.
FT_THESAURUS (1024) uses thesaurus synonyms.

start&

Long. Optional. The starting page to return.

count%

Integer. Optional. The number of pages to return.

entryform$

The name of the search form in the domain catalog.

Return value

notesDocument

A NotesDocument with a formatted list of matching documents.

Usage

The databases you want included in the search must have the property "Include in multi-database indexing" set to TRUE.

The current NotesDatabase object must represent a Domain Catalog.

If you don't specify any sort options, you get the documents sorted by relevance score. If you ask for a sort by date, you don't get relevance scores.

Query syntax

To search for a word or phrase, enter the word or phrase as is, except for 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

FTDomainSearch method in Java Database class

See examples

Examples: FTDomainSearch method

Library | Support | Terms of use |

Last updated: Monday, October 5, 2009