microsoft.exchange.webservices.data.core.request
Class MoveCopyItemRequest<TResponse extends ServiceResponse>

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.MoveCopyItemRequest<TResponse>

Type Parameters:

TResponse - The type of the response.

Direct Known Subclasses:

CopyItemRequest, MoveItemRequest

public abstract class MoveCopyItemRequest<TResponse extends ServiceResponse>
extends MultiResponseServiceRequest<TResponse>

Represents an abstract Move/Copy Item request.

Constructor Summary

protected

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

Method Summary

FolderId	getDestinationFolderId() Gets the destination folder id.
protected int	getExpectedResponseMessageCount() Gets the expected response message count.
ItemIdWrapperList	getItemIds() Gets the item ids.
protected Boolean	getReturnNewItemIds()
void	setDestinationFolderId(FolderId destinationFolderId) Sets the destination folder id.
void	setReturnNewItemIds(Boolean value)
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

createServiceResponse, endExecute, execute, getErrorHandlingMode, getResponseMessageXmlElementName, 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, getMinimumRequiredServerVersion, getResponseStream, getResponseXmlElementName, getService, getXmlElementName, 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

MoveCopyItemRequest

protected MoveCopyItemRequest(ExchangeService service,
                              ServiceErrorHandling errorHandlingMode)
                       throws Exception

Initializes a new instance of the class.

Parameters:

service - the service

errorHandlingMode - the error handling mode

Throws:

Exception - on error

Method Detail

validate

public void validate()
              throws Exception

Validates request.

Throws:

Exception - the exception

writeIdsToXml

protected void writeIdsToXml(EwsServiceXmlWriter writer)
                      throws Exception

Writes the ids as XML.

Parameters:

writer - the writer

Throws:

Exception - the exception

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.

getItemIds

public ItemIdWrapperList getItemIds()

Gets the item ids.

Returns:

the item ids

getReturnNewItemIds

protected Boolean getReturnNewItemIds()

setReturnNewItemIds

public void setReturnNewItemIds(Boolean value)

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