Package microsoft.exchange.webservices.data.core.request

Class SyncFolderHierarchyRequest

java.lang.Object

microsoft.exchange.webservices.data.core.request.ServiceRequestBase<T>

microsoft.exchange.webservices.data.core.request.SimpleServiceRequestBase<ServiceResponseCollection<TResponse>>

microsoft.exchange.webservices.data.core.request.MultiResponseServiceRequest<SyncFolderHierarchyResponse>

microsoft.exchange.webservices.data.core.request.SyncFolderHierarchyRequest

public class SyncFolderHierarchyRequest
extends MultiResponseServiceRequest<SyncFolderHierarchyResponse>

Represents a SyncFolderHierarchy request.

Constructor Summary

Constructors

Constructor	Description
SyncFolderHierarchyRequest(ExchangeService service)	Initializes a new instance of the class.

Method Summary

Modifier and Type	Method	Description
protected SyncFolderHierarchyResponse	createServiceResponse(ExchangeService service, int responseIndex)	Creates the service response.
protected int	getExpectedResponseMessageCount()	Gets the expected response message count.
protected ExchangeVersion	getMinimumRequiredServerVersion()	Gets the request version.
PropertySet	getPropertySet()	Gets or sets the property set.
protected String	getResponseMessageXmlElementName()	Gets the name of the response message XML element.
protected String	getResponseXmlElementName()	Gets the name of the response XML element.
FolderId	getSyncFolderId()	Gets or sets the property set.
String	getSyncState()	Gets or sets the state of the sync.
String	getXmlElementName()	Gets the name of the XML element.
void	setPropertySet(PropertySet value)	Sets the property set.
void	setSyncFolderId(FolderId value)	Sets the sync folder id.
void	setSyncState(String value)	Sets the sync state.
protected void	validate()	Validates request.
protected void	writeElementsToXml(EwsServiceXmlWriter writer)	Writes XML elements.

Methods inherited from class microsoft.exchange.webservices.data.core.request.MultiResponseServiceRequest

endExecute, execute, getErrorHandlingMode, parseResponse

Methods inherited from class microsoft.exchange.webservices.data.core.request.SimpleServiceRequestBase

beginExecute, endInternalExecute, internalExecute

Methods inherited from class microsoft.exchange.webservices.data.core.request.ServiceRequestBase

buildEwsHttpPoolingWebRequest, buildEwsHttpWebRequest, getEwsHttpWebResponse, getResponseStream, getService, processWebException, readPreamble, readResponse, readResponse, readSoapFault, throwIfNotSupportedByRequestedServerVersion, traceResponse, validateAndEmitRequest, writeAttributesToXml, writeBodyToXml, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncFolderHierarchyRequest

public SyncFolderHierarchyRequest(ExchangeService service)
                           throws Exception

Initializes a new instance of the class.

Parameters:

service - the service

Throws:

Exception

Method Detail

createServiceResponse

protected SyncFolderHierarchyResponse createServiceResponse(ExchangeService service,
                                                            int responseIndex)

Creates the service response.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<SyncFolderHierarchyResponse>

Parameters:

service - the service

responseIndex - the response index

Returns:

Service response.

getExpectedResponseMessageCount

protected int getExpectedResponseMessageCount()

Gets the expected response message count.

Specified by:

getExpectedResponseMessageCount in class MultiResponseServiceRequest<SyncFolderHierarchyResponse>

Returns:

Number of expected response

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<ServiceResponseCollection<SyncFolderHierarchyResponse>>

Returns:

XML element name

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<ServiceResponseCollection<SyncFolderHierarchyResponse>>

Returns:

XML element name

getResponseMessageXmlElementName

protected String getResponseMessageXmlElementName()

Gets the name of the response message XML element.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<SyncFolderHierarchyResponse>

Returns:

XML element name

validate

protected void validate()
                 throws Exception

Validates request.

Overrides:

validate in class ServiceRequestBase<ServiceResponseCollection<SyncFolderHierarchyResponse>>

Throws:

Exception - the exception

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Writes XML elements.

Specified by:

writeElementsToXml in class ServiceRequestBase<ServiceResponseCollection<SyncFolderHierarchyResponse>>

Parameters:

writer - the writer

Throws:

Exception - the exception

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<SyncFolderHierarchyResponse>>

Returns:

Earliest Exchange version in which this request is supported.

getPropertySet

public PropertySet getPropertySet()

Gets or sets the property set.

Returns:

the property set

setPropertySet

public void setPropertySet(PropertySet value)

Sets the property set.

Parameters:

value - the new property set

getSyncFolderId

public FolderId getSyncFolderId()

Gets or sets the property set.

Returns:

the sync folder id

setSyncFolderId

public void setSyncFolderId(FolderId value)

Sets the sync folder id.

Parameters:

value - the new sync folder id

getSyncState

public String getSyncState()

Gets or sets the state of the sync.

Returns:

the sync state

setSyncState

public void setSyncState(String value)

Sets the sync state.

Parameters:

value - the new sync state