microsoft.exchange.webservices.data
Class GetEventsResults

java.lang.Object
  extended by microsoft.exchange.webservices.data.GetEventsResults

public final class GetEventsResults
extends java.lang.Object

Represents a collection of notification events.


Constructor Summary
protected GetEventsResults()
          Initializes a new instance.
 
Method Summary
 java.util.Collection<NotificationEvent> getAllEvents()
          Gets the collection of all events.
 java.lang.Iterable<FolderEvent> getFolderEvents()
          Gets the collection of folder events.
 java.lang.Iterable<ItemEvent> getItemEvents()
          Gets the collection of item events.
protected  java.lang.String getNewWatermark()
          Gets the subscription's new watermark.
protected  java.lang.String getPreviousWatermark()
          Gets the subscription's previous watermark.
protected  java.lang.String getSubscriptionId()
          Gets the Id of the subscription the collection is associated with.
protected static java.util.Map<java.lang.String,EventType> getXmlElementNameToEventTypeMap()
          Gets the XML element name to event type mapping.
protected  boolean isMoreEventsAvailable()
          Gets a value indicating whether more events are available on the Exchange server.
protected  void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
          Loads from XML.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetEventsResults

protected GetEventsResults()
Initializes a new instance.

Method Detail

getXmlElementNameToEventTypeMap

protected static java.util.Map<java.lang.String,EventType> getXmlElementNameToEventTypeMap()
Gets the XML element name to event type mapping.

Returns:
The XML element name to event type mapping.

loadFromXml

protected void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                    throws java.lang.Exception
Loads from XML.

Parameters:
reader - the reader
Throws:
java.lang.Exception - the exception

getSubscriptionId

protected java.lang.String getSubscriptionId()
Gets the Id of the subscription the collection is associated with.

Returns:
the subscription id

getPreviousWatermark

protected java.lang.String getPreviousWatermark()
Gets the subscription's previous watermark.

Returns:
the previous watermark

getNewWatermark

protected java.lang.String getNewWatermark()
Gets the subscription's new watermark.

Returns:
the new watermark

isMoreEventsAvailable

protected boolean isMoreEventsAvailable()
Gets a value indicating whether more events are available on the Exchange server.

Returns:
true, if is more events available

getFolderEvents

public java.lang.Iterable<FolderEvent> getFolderEvents()
Gets the collection of folder events.

Returns:
the folder events

getItemEvents

public java.lang.Iterable<ItemEvent> getItemEvents()
Gets the collection of item events.

Returns:
the item events

getAllEvents

public java.util.Collection<NotificationEvent> getAllEvents()
Gets the collection of all events.

Returns:
the all events