com.ibm.notes.java.ui.views
Interface NotesUIViewEntryCollection

public interface NotesUIViewEntryCollection

Represents a collection of view entries from a Notes view.

Restriction:

This interface is not intended to be implemented by clients.

Method Summary

Iterator<NotesUIDocumentEntry>	documentIterator() Gets an iterator of only NotesUIDocumentEntry objects from the total overall collection.
NotesUIViewEntry	getFirstEntry() Gets the first view entry in this collection.
boolean	isOpen() Indicates whether the collection has been opened or not.
Iterator<NotesUIViewEntry>	iterator() Gets an iterator to iterate over this collection of entries.
void	open(CollectionOpenListener listener, boolean makeBusy) Open the collection and retrieve all the information for this collection.
int	size() Gets the size of this collection.

Method Detail

getFirstEntry

NotesUIViewEntry getFirstEntry()

Gets the first view entry in this collection. It is not necessary to call open(com.ibm.notes.java.ui.listeners.CollectionOpenListener, boolean) to get the first entry in the collection.

Returns:

the first view entry in this collection

Since:

8.5.2

iterator

Iterator<NotesUIViewEntry> iterator()

Gets an iterator to iterate over this collection of entries. This iterator will return null unless isOpen() returns true.

Returns:

an iterator to iterate over this collection of entries

Since:

8.5.2

size

int size()

Gets the size of this collection. The correct size of the collection is returned without calling open(com.ibm.notes.java.ui.listeners.CollectionOpenListener, boolean).

Returns:

the size of this collection

Since:

8.5.2

documentIterator

Iterator<NotesUIDocumentEntry> documentIterator()

Gets an iterator of only NotesUIDocumentEntry objects from the total overall collection. This iterator will return null unless the collection has been opened by calling open(com.ibm.notes.java.ui.listeners.CollectionOpenListener, boolean).

Returns:

an iterator of NotesUIDocumentEntry objects from the total overall collection.

Since:

8.5.2

isOpen

boolean isOpen()

Indicates whether the collection has been opened or not. If the collection has not been opened, calling any of the methods in this object may not succeed, unless indicated otherwise.

Returns:

true if the collection has been opened false otherwise

Since:

8.5.2

open

void open(CollectionOpenListener listener,
          boolean makeBusy)

Open the collection and retrieve all the information for this collection. This will also put the view in a busy state if makeBusy is set to true. This will prevent the selection from changing while opening the collection.

Parameters:

listener - listener which will be called when the collection has been opened, the listener will be called on a background thread

makeBusy - true will put the view in a half busy state when the listener is called, false will leave the view in its normal state

Since:

8.5.2