microsoft.exchange.webservices.data.core.request
Class CopyFolderRequest

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<TResponse>
              microsoft.exchange.webservices.data.core.request.CopyFolderRequest

public class CopyFolderRequest
extends MultiResponseServiceRequest<TResponse>

Represents a CopyFolder request.

Constructor Summary

CopyFolderRequest(ExchangeService service, ServiceErrorHandling errorHandlingMode)
Initializes a new instance of the CopyFolderRequest class.

Method Summary

protected MoveCopyFolderResponse	createServiceResponse(ExchangeService service, int responseIndex) Creates the service response.
FolderId	getDestinationFolderId() Gets the destination folder id.
protected int	getExpectedResponseMessageCount() Gets the expected response message count.
FolderIdWrapperList	getFolderIds() Gets the folder ids.
protected ExchangeVersion	getMinimumRequiredServerVersion() Gets the request version.
protected String	getResponseMessageXmlElementName() Gets the name of the response message XML element.
protected String	getResponseXmlElementName() Gets the name of the response XML element.
String	getXmlElementName() Gets the name of the XML element.
void	setDestinationFolderId(FolderId destinationFolderId) Sets the destination folder id.
protected void	validate() Validates request.
protected void	writeElementsToXml(EwsServiceXmlWriter writer) Writes XML elements.
protected void	writeIdsToXml(EwsServiceXmlWriter writer) Writes the ids as XML.

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

CopyFolderRequest

public CopyFolderRequest(ExchangeService service,
                         ServiceErrorHandling errorHandlingMode)
                  throws Exception

Initializes a new instance of the CopyFolderRequest class.

Parameters:

service - the service

errorHandlingMode - the error handling mode

Throws:

Exception

Method Detail

createServiceResponse

protected MoveCopyFolderResponse createServiceResponse(ExchangeService service,
                                                       int responseIndex)

Creates the service response.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<MoveCopyFolderResponse>

Parameters:

service - The Service

responseIndex - Index of the response.

Returns:

Service response.

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<ServiceResponseCollection<MoveCopyFolderResponse>>

Returns:

XML element name

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<ServiceResponseCollection<MoveCopyFolderResponse>>

Returns:

XML element name

getResponseMessageXmlElementName

protected String getResponseMessageXmlElementName()

Gets the name of the response message XML element.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<MoveCopyFolderResponse>

Returns:

XML element name.

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<MoveCopyFolderResponse>>

Returns:

Earliest Exchange version in which this request is supported.

validate

protected void validate()
                 throws Exception

Validates request.

Throws:

Exception - the exception

writeIdsToXml

protected void writeIdsToXml(EwsServiceXmlWriter writer)

Writes the ids as XML.

Parameters:

writer - the writer

getExpectedResponseMessageCount

protected int getExpectedResponseMessageCount()

Gets the expected response message count.

Specified by:

getExpectedResponseMessageCount in class MultiResponseServiceRequest<TResponse extends ServiceResponse>

Returns:

Number of expected response messages.

getFolderIds

public FolderIdWrapperList getFolderIds()

Gets the folder ids.

Returns:

The folder ids.

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Writes XML elements.

Specified by:

writeElementsToXml in class ServiceRequestBase<ServiceResponseCollection<TResponse extends ServiceResponse>>

Parameters:

writer - the writer

Throws:

Exception - the exception

getDestinationFolderId

public FolderId getDestinationFolderId()

Gets the destination folder id.

Returns:

the destination folder id

setDestinationFolderId

public void setDestinationFolderId(FolderId destinationFolderId)

Sets the destination folder id.

Parameters:

destinationFolderId - the new destination folder id