Displays the summary information of a subset of documents in a database. You can use the key and ftsearch attributes to further qualify the subset.

Valid in:

None required; db, session

viewloop, page, ifdbrole, docloop, ifauthor, ifdepositor, ifdesigner, ifeditor, ifmanager, ifnoaccess, novalues, ifreader

<domino:view
id="name of object variable"
dbname="database name"
dbserver="database server name"
viewname="view name"
defaultname="default view name"
key="key"
keyseparator="blank|comma|colon|semicolon| |,|:|;"
keytype="string|number|date|daterange"
keyexact="true|false"
ftsearch="search string"
max="maximum number of entries to return"
toponly="true|false"
depth="number of level to process to"
category="category that all documents returned must fall under"
user="login information for the session"
password="password associated with user name"
enableselect="true|false"
host="CORBA server name"
debug="true|false"
onfailure="inline|exception"
time="true|false">

The following attributes are optional:

category

Returns documents that exist under specified category. A hierarchical category name can be specified. Produces an error if used with the key or ftsearch attributes.

Name of the database that contains the view.

Name of the server hosting the database.

Specifies the default view name if one is not specified as a page argument. This supports using a viewloop linked to the view tag on the same page. The first time through the loop, no value is available, so this default value is used.

Indicates the level in the document hierarchy to display. To process top-level documents only, indicate 0. To process top-level and response documents, indicate 1. To process top-level, response, and response-to-response documents, indicate 2. ("true" in the toponly attribute is equivalent to a value of 0 in this attribute.) This attribute is ignored if used in a non-hierarchical view.

If true, indicates that document entries in the view can be selected by clicking the selection checkbox. See the selectentry tag. You can process documents that are selected this way using either:
• a selectedloop tag
• an EventContext.getSelectedDocuments() call in the context of an ifserverevent tag
Note An error is generated if you specify more than one view tag with the enableselect attribute set to true on a single page.

Default is false.

Search string used to perform a full text search. If not specified or if null is passed, no full text search is performed. Category and totals entries are not returned when you use this attribute.

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.

If you specify an id name, creates a page-level variable that contains the associated lotus.domino.View object. The variable created is only available within the body of the view tag. If not specified, no programmatic access to the View object is available.

Filters the returned document entries based on the passed value and the first sorted column in the view. If not specified, then all documents are returned. Category and totals entries are not returned when you use this attribute.

If true, indicates that an exact match to the key attribute should be made when selecting view documents. Default is false, which indicates a partial match is required.

Separator character to use to separate multiple values in a multi-value key. Must be one of: blank, comma, colon, or semicolon. You can specify the separator using the character as well, for example, (;) or (:). If not specified, the key is treated as a single value.

Data type that the key values are converted into. Must be one of: string, number, date, or daterange. A daterange is represented by two dates separated by a dash (-). For example, 2001/04/01-2001/04/05. If used with a multi-value key, the data type for each key should be separated by a comma (,). For example, "string, number, string." Default is string.

Number value that limits how many view entries the view displays. By default all entries in the view are returned.

Password associated with the user specified in the user attribute.

If true, for hierarchical or categorized views, processes only the top-level entries (category titles). True is equivalent to indicating a value of 0 in the depth attribute. This attribute is ignored if used in a non-hierarchical view. Default is false.

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

Name of the view. For example, "Inbox". Defaults to the name passed in as an argument or to the defaultname attribute if one is specified.

Example
See Also

The Domtags tag library

Glossary