createViewNavFrom (View - Java™)

Creates a view navigator for all entries in a view starting at a specified entry.

Defined in

View

Syntax

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

Parameters

Object entry

A Document or ViewEntry object representing the starting 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 first entry in the navigator is the specified entry. The remaining entries are all the entries in the view that follow the first entry.

If the object is not found, 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