Home
HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
Java/CORBA Classes
This section documents the Java/CORBA classes.
Java™ Classes A-Z
View (Java™)
Represents a view or folder of a database and provides access to documents within it.
createViewNav (View - Java™)
Creates a view navigator for all entries in a view.

HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in HCL Domino Designer 12?
  The following features are new for developers in HCL Domino® Designer 12.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino® Query Language (DQL) is a facility running on a Domino server that provides a terse, shorthand syntax for finding documents. It supports a wide variety and complexity of search terms. It leverages existing design elements, avoiding the need to write detailed code to access them. DQL consolidates all methods in Domino for searching document contents.
- Composite Applications - Design and Management
  Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
- Formula Language
  This section documents the formula language.
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
- LotusScript/COM/OLE Classes
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
  - Java™ Classes Coding Guidelines
  - Java™ Classes A-Z
    - Properties and methods with ECL security using Java™
      The following tables list the properties and methods affected by an execute control list (ECL). These properties cannot be accessed or set, and these methods do not execute on the workstation unless the marked ECL priveleges are granted to the signer of the formula.
    - Java™ constants
      The following sections provide contextual information for the constants used by the Java™ classes. Listed are the constant names, their integer values (in parentheses), and the properties and methods in which they are used.
    - Supporting components
      The following classes support the use of Java™ with Notes/Domino and the Domino® Objects:
    - ACL (Java™)
      Represents the access control list (ACL) of a database.
    - ACLEntry (Java™)
      Represents a single entry in an access control list. An entry may be for a person, a group, or a server.
    - AdministrationProcess (Java™)
    - Agent (Java™)
      Represents an agent.
    - AgentContext (Java™)
      Represents the agent environment of the current program, if an agent is running it.
    - ColorObject (Java™)
    - Database (Java™)
      Represents a Notes® database.
    - DateRange (Java™)
      Represents a range of dates and times.
    - DateTime (Java™)
      Represents a date and time.
    - DbDirectory (Java™)
      Represents the Domino® databases on a server or the local computer.
    - Directory (Java™)
      Represents the Notes® directories on a specific server or local computer, each of which is associated with one or more directory navigators to allow directory lookups.
    - DirectoryNavigator (Java™)
      Allows lookups of a specific associated Notes® directory on a specific server or local computer.
    - Document (Java™)
      Represents a document in a database.
    - DocumentCollection (Java™)
      Represents a collection of documents from a database, selected according to specific criteria.
    - DominoQuery (Java)
      Java class to compile, tune, and run Domino Query Language (DQL) queries.
    - DxlExporter (Java™)
    - DxlImporter (Java™)
    - EmbeddedObject (Java™)
      Represents any one of the following:
    - Form (Java™)
      Represents a form in a database.
    - IDVault (Java™)
      The IDVault class is a representation of the secure storage facility for UserIDs that may be configured for Domino by policy. IDs are stored there to allow for easier management by administrators and users. IDs from more than one server may be stored within an IDVault. The IDVault class provides methods to access UserID files, UserID objects, query the presence of an ID in the vault, sycnronise copies of IDs, and reset passwords. The IDVault class can be used to access UserID objects or files. These can be used to accomplish the encryption or decryption of Documents while running on the server.
    - International (Java™)
      Represents the international settings in the operating environment, for example, the Regional Settings in the Windows™ Control Panel. When settings change in the operating environment, Notes® recognizes the new settings immediately. For remote (IIOP) operations, these settings represent the session's server.
    - Item (Java™)
      Represents a discrete value or set of values in a document.
    - Log (Java™)
      Enables you to record actions and errors that take place during a program's execution. You can record actions and errors in:
    - MIMEEntity (Java™)
      Represents an item of type MIME (Multipurpose Internet Mail Extensions).
    - MIMEHeader (Java™)
      Represents a header in a MIME (Multipurpose Internet Mail Extensions) document.
    - Name (Java™)
      Represents a user or server name.
    - Newsletter (Java™)
      Document or set of documents that contains information from, or links to, several other documents.
    - NoteCollection (Java™)
    - NotesCalendar (Java)
      Represents a Domino® calendar.
    - NotesCalendarEntry (Java)
      Represents a Domino® calendar entry.
    - NotesCalendarNotice (Java)
      Represents a Domino® calendar notice.
    - Outline (Java™)
      Represents an outline in a database.
    - OutlineEntry (Java™)
      Represents an entry in an outline.
    - NotesProperty (Java™)
      Represents a single property in the Composite Applications properties of a Domino® application. Properties are data transmitted to or from the Property Broker, which routes your application's communication with other components in a composite application. Properties are defined in a Wiring Properties design element.
    - PropertyBroker (Java™)
      Mediates communication between components of a composite application, allowing communication between multiple Java™ components, or between Notes® and Java components.
    - QueryResultsProcessor (Java™)
      Aggregates, computes, sorts, and formats collections of documents across any set of Domino databases.
    - Registration (Java™)
      Represents the creation or administration of an ID file.
    - Replication (Java™)
      Represents the replication settings of a database.
    - ReplicationEntry (Java™)
    - RichTextDoclink (Java™)
    - RichTextItem (Java™)
      Represents an item of type rich text.
    - RichTextNavigator (Java™)
    - RichTextParagraphStyle (Java™)
      Represents rich text paragraph attributes.
    - RichTextRange (Java™)
    - RichTextSection (Java™)
    - RichTextStyle (Java™)
      Represents rich-text attributes.
    - RichTextTab (Java™)
      Represents a tab in a rich text paragraph style.
    - RichTextTable (Java™)
    - Session (Java™)
    - Stream (Java™)
      Represents a stream of binary or character data.
    - UserID (Java™)
      The UserID class represents the Notes ID file or a Notes ID when it resides within the Domino IDVault. This object is primarily used to obtain the names of the private encryption keys which are available for use within the UserID object.
    - View (Java™)
      Represents a view or folder of a database and provides access to documents within it.
      - Examples: View class
      - Aliases (View - Java™)
        Read-write. The aliases of a view.
      - AllEntries (View - Java™)
        Read-only. All document entries in a view in view order.
      - BackgroundColor (View - Java™)
        Read-write. The background color of a view.
      - ColumnCount (View - Java™)
        Read-only. The number of columns in a view.
      - ColumnNames (View - Java™)
        Read-only. The names of the columns in a view.
      - Columns (View - Java™)
        Read-only. The columns in a view.
      - Created (View - Java™)
        Read-only. The date and time when a view was created.
      - EntryCount (View - Java™)
        Read-only. The number of documents in a view.
      - HeaderLines (View - Java™)
        Read-only. The number of lines in the header of a view.
      - HttpURL (View - Java™)
      - IsAutoUpdate (View - Java™)
        Read-write. Indicates whether a view is automatically refreshed when a navigation method touches an update (addition, deletion, or change) to the database that occurred after view creation or the last refresh.
      - IsCalendar (View - Java™)
        Read-only. Indicates whether a view is a calendar view.
      - IsCategorized (View - Java™)
        Read-only. Indicates whether a view is categorized.
      - IsConflict (View - Java™)
        Read-only. Indicates whether a view is enabled for conflict checking.
      - IsDefaultView (View - Java™)
      - IsFolder (View - Java™)
        Read-only. Indicates whether a View object represents a folder.
      - IsHierarchical (View - Java™)
        Read-only. Indicates whether a view shows response documents in a hierarchy.
      - IsModified (View - Java™)
        Read-only. Indicates whether a view is modified.
      - IsPrivate (View - Java™)
        Read-only. Indicates whether a view is private or shared on first use.
      - IsProhibitDesignRefresh (View - Java™)
      - IsProtectReaders (View class - Java™)
        Read-Write. Protects $Readers items from being overwritten by replication.
      - LastModified (View - Java™)
        Read-only. The date that a view was last modified.
      - LockHolders (View - Java™)
      - Name (View - Java™)
      - NotesURL (View - Java™)
      - Parent (View - Java™)
        Read-only. The database to which a view belongs.
      - Readers (View class - Java™)
        Read-Write. The contents of the $Readers field associated with the view.
      - RowLines (View - Java™)
        Read-only. The number of lines in each row of a view.
      - SelectionFormula (View - Java™)
      - Spacing (View - Java™)
      - TopLevelEntryCount (View - Java™)
        Read-only. The number of top-level entries in a view.
      - UniversalID (View - Java™)
        Read-only. The universal ID of a view, which is a 32-character hexadecimal value that uniquely identifies a view across all replicas of a database.
      - ViewInheritedName (View - Java™)
      - clear (View - Java™)
        Clears the full-text search filtering on a view.
      - copyColumn (View - Java™)
      - createColumn (View - Java™)
      - createViewNav (View - Java™)
        Creates a view navigator for all entries in a view.
        Examples: createViewNav method
        This agent gets all the entries in a view.
      - createViewNavFrom (View - Java™)
        Creates a view navigator for all entries in a view starting at a specified entry.
      - createViewNavFromAllUnread (View - Java™)
        Creates a view navigator for all unread entries in a view.
      - createViewNavFromCategory (View - Java™)
        Creates a view navigator for all entries in a view under a specified category.
      - createViewNavFromChildren (View - Java™)
        Creates a view navigator for the immediate children of a specified entry.
      - createViewNavFromDescendants (View - Java™)
        Creates a view navigator for all the descendants of a specified entry.
      - createViewNavMaxLevel (View - Java™)
        Creates a view navigator for all entries in a view down to a specified level.
      - FTSearch (View - Java™)
        Conducts a full-text search on all documents in a view and filters the view so it represents only those documents that match the full-text query. This method does not find word variants.
      - FTSearchSorted (View - Java™)
        Conducts a full-text search on all documents in a view and filters the view so it represents only those documents that match the full-text query in sorted order.
      - getAllDocumentsByKey (View - Java™)
        Finds documents based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all documents whose column values match the keys.
      - getAllEntriesByKey (View - Java™)
        Finds view entries of type document based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys.
      - getAllReadEntries (View - Java™)
        The method returns all entries associated with documents that have been read.
      - getAllUnreadEntries (View - Java™)
        The method returns all entries associated with documents that have not been read.
      - getChild (View - Java™)
        Given a document in a view, returns the first response to the document.
      - getColumn (View - Java™)
        Returns a specified column in a view.
      - getDocumentByKey (View - Java™)
        Finds a document based on its column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns the first document with column values that match the keys.
      - getEntryByKey (View - Java™)
        Finds a view entry of type document based on its column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns the first entry with column values that match the keys.
      - getFirstDocument (View - Java™)
        Returns the first document in a view.
      - getLastDocument (View - Java™)
        Returns the last document in a view.
      - getNextDocument (View - Java™)
        Given a document in a view, returns the document immediately following it.
      - getNextSibling (View - Java™)
        Given a document in a view, returns the document immediately following it at the same level. If you send the method a main document, the next main document in the view is returned. If you send a response document, the next response document with the same parent is returned.
      - getNthDocument (View - Java™)
        Returns the document at a specified position in the top level of a view.
      - getParentDocument (View - Java™)
        Given a response document in a view, returns its parent document.
      - getPrevDocument (View - Java™)
        Given a document in a view, returns the document immediately preceding it.
      - getPrevSibling (View - Java™)
        Given a document in a view, returns the document immediately preceding it at the same level. If you use this method on a main document, the preceding main document in the view is returned. If you use it on a response document, the preceding response document with the same parent is returned.
      - lock (View - Java™)
      - lockProvisional (View - Java™)
      - markAllRead (View - Java™)
        Marks all documents in the view as read.
      - markAllUnread (View - Java™)
        Marks all documents in the view as unread.
      - refresh (View - Java™)
        Updates view contents to reflect any updates to the database since the View object was created, or since the last refresh.
      - remove (View - Java™)
        Permanently removes a view from a database.
      - removeColumn (View - Java™)
      - resortView (View - Java™)
        Resorts a view.
      - setAliases (View - Java™)
      - unlock (View - Java™)
    - ViewColumn (Java™)
      Represents a column in a view or folder.
    - ViewEntry (Java™)
      Represents a view entry. A view entry describes a row in a view.
    - ViewEntryCollection (Java™)
      Represents a collection of view entries of type document sorted in view order.
    - ViewNavigator (Java™)
      Represents a view navigator. A view navigator provides access to all or a subset of the entries in a view.
- Connectors
  Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.

createViewNav (View - Java™)

Creates a view navigator for all entries in a view.

Defined in

Syntax

public ViewNavigator createViewNav()
    throws NotesException
public ViewNavigator createViewNav(int cacheSize)
    throws NotesException

Parameters

int cacheSize

The size of the navigator cache in view entries. Legal values are 0 (no cache) through 128 (default). Applies only to remote (IIOP) operations.

Return value


ViewNavigator

The new view navigator.

Usage

The navigator contains all entries even if the view is filtered for a full-text search. Use a ViewEntryCollection object to navigate a view filtered by a full-text search.

An empty view results in an empty navigator. All navigation methods return null.

The cache enhances performance for iterative processing of entries using the navigation methods that do not take a parameter.

Example