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

Class DeleteItemRequest

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.DeleteItemRequest

public final class DeleteItemRequest
extends MultiResponseServiceRequest<TResponse>

Represents a DeleteItem request.

Constructor Summary

Constructors

Constructor	Description
DeleteItemRequest(ExchangeService service, ServiceErrorHandling errorHandlingMode)	Initializes a new instance of the class.

Method Summary

Modifier and Type	Method	Description
protected ServiceResponse	createServiceResponse(ExchangeService service, int responseIndex)	Creates the service response.
DeleteMode	getDeleteMode()	Gets the delete mode.
protected int	getExpectedResponseMessageCount()	Gets the expected response message count.
ItemIdWrapperList	getItemIds()	Gets the item 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	setAffectedTaskOccurrences(AffectedTaskOccurrence affectedTaskOccurrences)	Sets the affected task occurrences.
void	setDeleteMode(DeleteMode deleteMode)	Gets the delete mode.e
void	setSendCancellationsMode(SendCancellationsMode sendCancellationsMode)	Sets the send cancellations mode.
protected void	validate()	Validate request.
protected void	writeAttributesToXml(EwsServiceXmlWriter writer)	Writes XML attribute.
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, writeBodyToXml, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteItemRequest

public DeleteItemRequest(ExchangeService service,
                         ServiceErrorHandling errorHandlingMode)
                  throws Exception

Initializes a new instance of the class.

Parameters:

service - the service

errorHandlingMode - the error handling mode

Throws:

Exception

Method Detail

validate

protected void validate()
                 throws Exception

Validate request.

Overrides:

validate in class ServiceRequestBase<ServiceResponseCollection<ServiceResponse>>

Throws:

Exception - the exception

getExpectedResponseMessageCount

protected int getExpectedResponseMessageCount()

Gets the expected response message count.

Specified by:

getExpectedResponseMessageCount in class MultiResponseServiceRequest<ServiceResponse>

Returns:

Number of expected response messages

createServiceResponse

protected ServiceResponse createServiceResponse(ExchangeService service,
                                                int responseIndex)

Creates the service response.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<ServiceResponse>

Parameters:

service - the service

responseIndex - the response index

Returns:

Service response.

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<ServiceResponseCollection<ServiceResponse>>

Returns:

XML element name

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<ServiceResponseCollection<ServiceResponse>>

Returns:

XML element name

getResponseMessageXmlElementName

protected String getResponseMessageXmlElementName()

Gets the name of the response message XML element.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<ServiceResponse>

Returns:

XML element name

writeAttributesToXml

protected void writeAttributesToXml(EwsServiceXmlWriter writer)
                             throws ServiceXmlSerializationException

Writes XML attribute.

Parameters:

writer - the writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Writes XML elements.

Specified by:

writeElementsToXml in class ServiceRequestBase<ServiceResponseCollection<ServiceResponse>>

Parameters:

writer - the writer

Throws:

Exception - the exception

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<ServiceResponse>>

Returns:

Earliest Exchange version in which this request is supported.

getItemIds

public ItemIdWrapperList getItemIds()

Gets the item ids.

Returns:

the item ids

setAffectedTaskOccurrences

public void setAffectedTaskOccurrences(AffectedTaskOccurrence affectedTaskOccurrences)

Sets the affected task occurrences.

Parameters:

affectedTaskOccurrences - the new affected task occurrences

setSendCancellationsMode

public void setSendCancellationsMode(SendCancellationsMode sendCancellationsMode)

Sets the send cancellations mode.

Parameters:

sendCancellationsMode - the new send cancellations mode

getDeleteMode

public DeleteMode getDeleteMode()

Gets the delete mode.

Returns:

the delete mode

setDeleteMode

public void setDeleteMode(DeleteMode deleteMode)

Gets the delete mode.e

Parameters:

deleteMode - the new delete mode