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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected SyncFolderHierarchyResponsecreateServiceResponse(ExchangeService service, int responseIndex)Creates the service response.protected intgetExpectedResponseMessageCount()Gets the expected response message count.protected ExchangeVersiongetMinimumRequiredServerVersion()Gets the request version.PropertySetgetPropertySet()Gets or sets the property set.protected StringgetResponseMessageXmlElementName()Gets the name of the response message XML element.protected StringgetResponseXmlElementName()Gets the name of the response XML element.FolderIdgetSyncFolderId()Gets or sets the property set.StringgetSyncState()Gets or sets the state of the sync.StringgetXmlElementName()Gets the name of the XML element.voidsetPropertySet(PropertySet value)Sets the property set.voidsetSyncFolderId(FolderId value)Sets the sync folder id.voidsetSyncState(String value)Sets the sync state.protected voidvalidate()Validates request.protected voidwriteElementsToXml(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
-
-
-
-
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:
createServiceResponsein classMultiResponseServiceRequest<SyncFolderHierarchyResponse>- Parameters:
service- the serviceresponseIndex- the response index- Returns:
- Service response.
-
getExpectedResponseMessageCount
protected int getExpectedResponseMessageCount()
Gets the expected response message count.- Specified by:
getExpectedResponseMessageCountin classMultiResponseServiceRequest<SyncFolderHierarchyResponse>- Returns:
- Number of expected response
-
getXmlElementName
public String getXmlElementName()
Gets the name of the XML element.- Specified by:
getXmlElementNamein classServiceRequestBase<ServiceResponseCollection<SyncFolderHierarchyResponse>>- Returns:
- XML element name
-
getResponseXmlElementName
protected String getResponseXmlElementName()
Gets the name of the response XML element.- Specified by:
getResponseXmlElementNamein classServiceRequestBase<ServiceResponseCollection<SyncFolderHierarchyResponse>>- Returns:
- XML element name
-
getResponseMessageXmlElementName
protected String getResponseMessageXmlElementName()
Gets the name of the response message XML element.- Specified by:
getResponseMessageXmlElementNamein classMultiResponseServiceRequest<SyncFolderHierarchyResponse>- Returns:
- XML element name
-
validate
protected void validate() throws Exception
Validates request.- Overrides:
validatein classServiceRequestBase<ServiceResponseCollection<SyncFolderHierarchyResponse>>- Throws:
Exception- the exception
-
writeElementsToXml
protected void writeElementsToXml(EwsServiceXmlWriter writer) throws Exception
Writes XML elements.- Specified by:
writeElementsToXmlin classServiceRequestBase<ServiceResponseCollection<SyncFolderHierarchyResponse>>- Parameters:
writer- the writer- Throws:
Exception- the exception
-
getMinimumRequiredServerVersion
protected ExchangeVersion getMinimumRequiredServerVersion()
Gets the request version.- Specified by:
getMinimumRequiredServerVersionin classServiceRequestBase<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
-
-