com.mindoo.remote.api.com.ibm.notes.java.ui.views
Interface IRemoteNotesUIViewEntryCollection

All Superinterfaces:

IRemoteEclipseWrapper

public interface IRemoteNotesUIViewEntryCollection
extends IRemoteEclipseWrapper

Remote API Wrapper for the com.ibm.notes.java.ui.views.NotesUIViewEntryCollection (Online documentation)

Original documentation:
Represents a collection of view entries from a Notes view.

Method Summary

java.util.Iterator<IRemoteNotesUIDocumentEntry>	documentIterator() Gets an iterator of only IRemoteNotesUIDocumentEntry objects from the total overall collection.
IRemoteNotesUIViewEntry	getFirstEntry() Gets the first view entry in this collection.
boolean	isOpen() Indicates whether the collection has been opened or not.
java.util.Iterator<IRemoteNotesUIViewEntry>	iterator() Gets an iterator to iterate over this collection of entries.
void	openSync() Open the collection and retrieve all the information for this collection.
int	size() Gets the size of this collection.

Methods inherited from interface com.mindoo.remote.api.IRemoteEclipseWrapper

_internalGetId, equalWrappedObjects

Method Detail

getFirstEntry

IRemoteNotesUIViewEntry getFirstEntry()
                                      throws RemoteEclipseAPIException

Gets the first view entry in this collection. It is not necessary to call openSync() to get the first entry in the collection.

Returns:

the first view entry in this collection

Throws:

RemoteEclipseAPIException

iterator

java.util.Iterator<IRemoteNotesUIViewEntry> iterator()
                                                     throws RemoteEclipseAPIException

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

Throws:

RemoteEclipseAPIException

size

int size()
         throws RemoteEclipseAPIException

Gets the size of this collection. The correct size of the collection is returned without calling openSync().

Returns:

the size of this collection

Throws:

RemoteEclipseAPIException

documentIterator

java.util.Iterator<IRemoteNotesUIDocumentEntry> documentIterator()
                                                                 throws RemoteEclipseAPIException

Gets an iterator of only IRemoteNotesUIDocumentEntry objects from the total overall collection. This iterator will return null unless the collection has been opened by calling openSync().

Returns:

an iterator of NotesUIDocumentEntry objects from the total overall collection.

Throws:

RemoteEclipseAPIException

isOpen

boolean isOpen()
               throws RemoteEclipseAPIException

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

Throws:

RemoteEclipseAPIException

openSync

void openSync()
              throws RemoteEclipseAPIException

Open the collection and retrieve all the information for this collection. This will also put the view in a busy state and the method is blocking until the view is refreshed.

Throws:

RemoteEclipseAPIException