com.novell.application.console.snapin
Interface BrowserObjectEntryEnumeration

All Superinterfaces:

java.util.Enumeration, ObjectEntryEnumeration

All Known Subinterfaces:

IndexedObjectEntryEnumeration, VirtualObjectEntryEnumeration

All Known Implementing Classes:

DefaultBrowserObjectEntryEnumeration

public interface BrowserObjectEntryEnumeration

extends ObjectEntryEnumeration

Provides a browser ObjectEntry enumeration.

See Also:

DefaultBrowserObjectEntryEnumeration

Method Summary

int	moveFirst() Moves the enumeration cursor to the first entry in the enumeration.
int	moveLast() Moves the enumeration cursor to the last entry in the enumeration.
int	moveTo(java.lang.String target) Moves the enumeration cursor position to the entry that most matches the specified target name.
ObjectEntry	previous() Returns the previous entry in the enumeration.
void	refresh() Indicates that the enumeration needs to flush any cached data.
void	setBlockSize(int size) Sets the most frequent size in which the consumer of the enumeration will request entries from the enumeration.

Methods inherited from interface com.novell.application.console.snapin.ObjectEntryEnumeration

next

Methods inherited from interface java.util.Enumeration

hasMoreElements, nextElement

Method Detail

moveFirst

public int moveFirst()
              throws SnapinException

Moves the enumeration cursor to the first entry in the enumeration.

Returns:

The new enumeration cursor index

Throws:

SnapinException - Thrown by the service provider when an error occurs.

moveLast

public int moveLast()
             throws SnapinException

Moves the enumeration cursor to the last entry in the enumeration.

Returns:

The new enumeration cursor index

Throws:

SnapinException - Thrown by the service provider when an error occurs.

moveTo

public int moveTo(java.lang.String target)
           throws SnapinException

Moves the enumeration cursor position to the entry that most matches the specified target name.

If an exact match is not found, then the enumeration cursor position is moved to the entry which matches the target name the closest.

Parameters:

target - The name of the entry to which the enumeration cursor position will be moved.

Returns:

The new enumeration cursor position

Throws:

SnapinException - Thrown by the service provider when an error occurs.

previous

public ObjectEntry previous()
                     throws SnapinException

Returns the previous entry in the enumeration.

Returns:

The entry previous.

Throws:

SnapinException - Thrown by the service provider when an error occurs.

setBlockSize

public void setBlockSize(int size)

Sets the most frequent size in which the consumer of the enumeration will request entries from the enumeration.

If the consumer of the enumeration will call getNext() and getPrev() with a count parameter that is frequently limited to a given size, then setBlockSize() may be called to inform the enumeration of the consumers intentions.

The enumeration implementation may use the block size to allow caching more tailored to the consumers needs. In this case, the consumer may set the block size equal to one screen full of entries.

The block size may be changed at any time during the life of the enumeration

Parameters:

size - The block size.

refresh

public void refresh()

Indicates that the enumeration needs to flush any cached data.