HCL Domino - ftsearch tag - Need a Domino Consultant? Call NotesMail +1 212-599-2048

HCLSoftware Business Partner Domino Consulting Services CRUCIAL Notes Tools +1 212-599-2048	Domino Consulting Services CRUCIAL Notes Tools Domino administration Notes development	Chat now
.

Need a Domino Consultant? Call NotesMail +1 212-599-2048 - HCLSoftware Business Partner

JSP CUSTOM TAG LIBRARIES

ftsearch tag
Performs a full text search of a database. The result is a list of documents that fit the search criteria. Use the docloop or page tags to sequence over the resulting documents and the item or formula tags to display the summary data.

To perform a full text search of a view, use the ftsearch attribute of the view tag.

Contexts

Valid in:

None required,

Creates for:

Syntax

<domino:ftsearch id="name of object variable" dbname="database name" dbserver="server name" user="session information" password="password associated with user" query="search string" max="maximum number of documents to return" sort="dateascending|datedescending|score" options="database|filestytem|fuzzy|stems" host="CORBA server name" debug="true|false" onfailure="inline|exception" time="true|false">

Attributes

dbname

Name of the database to perform the search in. Optional.

dbserver

Name of the server that hosts the database. Optional.

host

Name of the Domino CORBA (Common Object Request Broker Architecture) server to use to host the back-end classes. If specified, forces a CORBA session. If not specified, a Domino server must be running locally on the same machine that is running the JSP Web container. Default is null which creates a local, non-CORBA, session. Optional.

If you specify an id name, creates a variable that contains the associated

lotus.domino.DocumentCollection object

. The variable created is only available within the body of the ftsearch tag. If not specified, no programmatic access to the DocumentCollection object is available. Optional.

max

Maximum number of documents to return. The default is to return all documents. Optional.

options

Further qualifies the search by specifying which type of search to perform:

Option Name	Definition
database	Includes Domino databases in the search scope.
filesystem	Includes files other than Domino databases in the search scope.
fuzzy	Retrieves words that have a similar spelling to the specified search query.
stems	Retrieves words that have the same root as the specified search query, but perhaps have different prefixes or suffixes.

You can specify multiple options, but must separate each with a comma(,). Optional.
password

Password associated with the user specified in the user attribute. Default is null. Optional.

query

String to use to perform the full text search. Required.

sort

Sort order of the resulting documents. Can be any of the following:

Option Name	Definition
dateascending	Sorts the resulting documents from the least to most recent based on the document's creation date.
datedescending	Sorts the resulting documents from the most to least recent based on the document's creation date.
score	Sorts the resulting documents beginning with the highest scoring matches based on the number of words specified in the query that match those in the resulting document.

Default is score. Optional.
user

Login information for the session. If this tag is being used in the context of a session tag, the value of this attribute is ignored. Optional.

See the Common Domino JSP tag attributes section for definitions of debug, onfailure, and time.

See Also

The Domtags tag library

Feedback on Help or Product Usability?

Help on Help

All Help Contents

Feedback on Help or Usability?

Help on Help

All Help Contents