createViewNavFromDescendants (View - Java™)

Creates a view navigator for all the descendants of a specified entry.

Defined in

View

Syntax

public ViewNavigator createViewNavFromDescendants(Object entry)
    throws NotesException
public ViewNavigator createViewNavFromDescendants(Object entry, int cacheSize)
    throws NotesException

Parameters

Object entry

A Document or ViewEntry object representing the parent entry. Cannot be null.

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 entries in the navigator are the entries in the view that fall hierarchically at all levels under the specified entry. The parent itself is excluded.

If the entry has no children, the result is 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