microsoft.exchange.webservices.data
Class SyncResponse<TServiceObject extends ServiceObject,TChange extends Change>

java.lang.Object
  extended by microsoft.exchange.webservices.data.ServiceResponse
      extended by microsoft.exchange.webservices.data.SyncResponse<TServiceObject,TChange>
Type Parameters:
TServiceObject - the generic type
TChange - the generic type
Direct Known Subclasses:
SyncFolderHierarchyResponse, SyncFolderItemsResponse

public abstract class SyncResponse<TServiceObject extends ServiceObject,TChange extends Change>
extends ServiceResponse

* Represents the base response class for synchronuization operations. ServiceObject type. Change type.


Constructor Summary
protected SyncResponse(PropertySet propertySet)
          * Initializes a new instance of the class.
 
Method Summary
protected abstract  TChange createChangeInstance()
          Creates the change instance.
 ChangeCollection<TChange> getChanges()
          * Gets a list of changes that occurred on the synchronized folder.
protected abstract  java.lang.String getIncludesLastInRangeXmlElementName()
          Gets the name of the includes last in range XML element.
protected abstract  boolean getSummaryPropertiesOnly()
          * Gets a value indicating whether this request returns full or summary properties.
protected  void readElementsFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
          * Reads response elements from XML.
 
Methods inherited from class microsoft.exchange.webservices.data.ServiceResponse
getBatchProcessingStopped, getErrorCode, getErrorDetails, getErrorMessage, getErrorProperties, getResult, internalThrowIfNecessary, loaded, loadExtraErrorDetailsFromXml, loadFromXml, mapErrorCodeToErrorMessage, parseMessageXml, setErrorMessage, throwIfNecessary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SyncResponse

protected SyncResponse(PropertySet propertySet)
* Initializes a new instance of the class.

Parameters:
propertySet - the property set
Method Detail

getIncludesLastInRangeXmlElementName

protected abstract java.lang.String getIncludesLastInRangeXmlElementName()
Gets the name of the includes last in range XML element.

Returns:
XML element name.

createChangeInstance

protected abstract TChange createChangeInstance()
Creates the change instance.

Returns:
TChange instance

readElementsFromXml

protected void readElementsFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                            throws ServiceLocalException,
                                   java.lang.Exception
* Reads response elements from XML.

Overrides:
readElementsFromXml in class ServiceResponse
Parameters:
reader - the reader
Throws:
ServiceLocalException - the service local exception
java.lang.Exception - the exception

getChanges

public ChangeCollection<TChange> getChanges()
* Gets a list of changes that occurred on the synchronized folder.

Returns:
the changes

getSummaryPropertiesOnly

protected abstract boolean getSummaryPropertiesOnly()
* Gets a value indicating whether this request returns full or summary properties.

Returns:
the summary properties only