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

Class SyncFolderItemsRequest

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<SyncFolderItemsResponse>

microsoft.exchange.webservices.data.core.request.SyncFolderItemsRequest

public class SyncFolderItemsRequest
extends MultiResponseServiceRequest<SyncFolderItemsResponse>

Represents a SyncFolderItems request.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected SyncFolderItemsResponse	createServiceResponse(ExchangeService service, int responseIndex)	Creates service response.
protected int	getExpectedResponseMessageCount()	Gets the expected response message count.
ItemIdWrapperList	getIgnoredItemIds()	Gets the list of ignored item ids.
int	getMaxChangesReturned()	Gets the maximum number of changes returned by SyncFolderItems.
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 the sync folder id.
SyncFolderItemsScope	getSyncScope()	Gets the scope of the sync.
String	getSyncState()	Gets the state of the sync.
String	getXmlElementName()	Gets the name of the XML element.
void	setMaxChangesReturned(int maxChangesReturned)	Sets the max changes returned.
void	setPropertySet(PropertySet propertySet)	Sets the property set.
void	setSyncFolderId(FolderId syncFolderId)	Sets the sync folder id.
void	setSyncScope(SyncFolderItemsScope syncScope)	Sets the sync scope.
void	setSyncState(String syncState)	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

SyncFolderItemsRequest

public SyncFolderItemsRequest(ExchangeService service)
                       throws Exception

Initializes a new instance of the class.

Parameters:

service - the service

Throws:

Exception

Method Detail

createServiceResponse

protected SyncFolderItemsResponse createServiceResponse(ExchangeService service,
                                                        int responseIndex)

Creates service response.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<SyncFolderItemsResponse>

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<SyncFolderItemsResponse>

Returns:

Number of expected response messages.

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<ServiceResponseCollection<SyncFolderItemsResponse>>

Returns:

XML element name

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<ServiceResponseCollection<SyncFolderItemsResponse>>

Returns:

XML element name

getResponseMessageXmlElementName

protected String getResponseMessageXmlElementName()

Gets the name of the response message XML element.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<SyncFolderItemsResponse>

Returns:

XML element name

validate

protected void validate()
                 throws Exception

Validates request.

Overrides:

validate in class ServiceRequestBase<ServiceResponseCollection<SyncFolderItemsResponse>>

Throws:

Exception - the exception

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Writes XML elements.

Specified by:

writeElementsToXml in class ServiceRequestBase<ServiceResponseCollection<SyncFolderItemsResponse>>

Parameters:

writer - the writer

Throws:

Exception - the exception

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<SyncFolderItemsResponse>>

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 propertySet)

Sets the property set.

Parameters:

propertySet - the new property set

getSyncFolderId

public FolderId getSyncFolderId()

Gets the sync folder id.

Returns:

the sync folder id

setSyncFolderId

public void setSyncFolderId(FolderId syncFolderId)

Sets the sync folder id.

Parameters:

syncFolderId - the new sync folder id

getSyncScope

public SyncFolderItemsScope getSyncScope()

Gets the scope of the sync.

Returns:

the sync scope

setSyncScope

public void setSyncScope(SyncFolderItemsScope syncScope)

Sets the sync scope.

Parameters:

syncScope - the new sync scope

getSyncState

public String getSyncState()

Gets the state of the sync.

Returns:

the sync state

setSyncState

public void setSyncState(String syncState)

Sets the sync state.

Parameters:

syncState - the new sync state

getIgnoredItemIds

public ItemIdWrapperList getIgnoredItemIds()

Gets the list of ignored item ids.

Returns:

the ignored item ids

getMaxChangesReturned

public int getMaxChangesReturned()

Gets the maximum number of changes returned by SyncFolderItems. Values must be between 1 and 512. Default is 100.

Returns:

the max changes returned

setMaxChangesReturned

public void setMaxChangesReturned(int maxChangesReturned)
                           throws ArgumentException

Sets the max changes returned.

Parameters:

maxChangesReturned - the new max changes returned

Throws:

ArgumentException - the argument exception