com.ibm.notes.java.ui.events
Class CollectionOpenedEvent

java.lang.Object
  com.ibm.notes.java.ui.events.CollectionOpenedEvent

All Implemented Interfaces:

NotesUIEvent

public class CollectionOpenedEvent
extends Object
implements NotesUIEvent

The event indicating that the NotesUIViewEntryCollection was opened and is ready to be used.

Constructor Summary

CollectionOpenedEvent(NotesUIViewEntryCollection collection, NotesException error)
Constructor.

Method Summary

NotesUIViewEntryCollection	getCollection() Gets the collection of view entries that were opened.
NotesException	getError() Gets any error that may have occurred while opening the collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionOpenedEvent

public CollectionOpenedEvent(NotesUIViewEntryCollection collection,
                             NotesException error)

Constructor.

Parameters:

collection - the collection that was opened

error - any error that may have occurred while opening the collection

Since:

8.5.2

Method Detail

getCollection

public NotesUIViewEntryCollection getCollection()

Gets the collection of view entries that were opened.

Returns:

the collection of view entries that were opened

Since:

8.5.2

getError

public NotesException  getError()

Gets any error that may have occurred while opening the collection. This method will return null if there was no error.

Specified by:

getError in interface NotesUIEvent

Returns:

any error that may have occurred while opening the collection

Since:

8.5.2