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

Class SendItemRequest

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

microsoft.exchange.webservices.data.core.request.SendItemRequest

public final class SendItemRequest
extends MultiResponseServiceRequest<ServiceResponse>

Represents a SendItem request.

Constructor Summary

Constructors

Constructor	Description
SendItemRequest(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.
protected int	getExpectedResponseMessageCount()	Gets the expected response message count.
Iterable<Item>	getItems()	Gets the item.
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.
FolderId	getSavedCopyDestinationFolderId()	Gets the saved copy destination folder id.
String	getXmlElementName()	Gets the name of the XML element.
void	setItems(Iterable<Item> items)	Sets the item.
void	setSavedCopyDestinationFolderId(FolderId savedCopyDestinationFolderId)	Sets the saved copy destination folder id.
protected void	validate()	Asserts the valid.
protected void	writeAttributesToXml(EwsServiceXmlWriter writer)	Writes the attribute to XML.
protected void	writeElementsToXml(EwsServiceXmlWriter writer)	Writes the elements to 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, writeBodyToXml, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

SendItemRequest

public SendItemRequest(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

Asserts the valid.

Overrides:

validate in class ServiceRequestBase<ServiceResponseCollection<ServiceResponse>>

Throws:

Exception - the exception

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.

getExpectedResponseMessageCount

protected int getExpectedResponseMessageCount()

Gets the expected response message count.

Specified by:

getExpectedResponseMessageCount in class MultiResponseServiceRequest<ServiceResponse>

Returns:

Number of expected response messages.

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 the attribute to XML.

Overrides:

writeAttributesToXml in class ServiceRequestBase<ServiceResponseCollection<ServiceResponse>>

Parameters:

writer - the writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Writes the elements to XML.

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.

getItems

public Iterable<Item> getItems()

Gets the item.

Returns:

the item

setItems

public void setItems(Iterable<Item> items)

Sets the item.

Parameters:

items - the new item

getSavedCopyDestinationFolderId

public FolderId getSavedCopyDestinationFolderId()

Gets the saved copy destination folder id.

Returns:

the saved copy destination folder id

setSavedCopyDestinationFolderId

public void setSavedCopyDestinationFolderId(FolderId savedCopyDestinationFolderId)

Sets the saved copy destination folder id.

Parameters:

savedCopyDestinationFolderId - the new saved copy destination folder id