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

Class ConvertIdRequest

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

microsoft.exchange.webservices.data.core.request.ConvertIdRequest

public final class ConvertIdRequest
extends MultiResponseServiceRequest<ConvertIdResponse>

Represents a ConvertId request.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected ConvertIdResponse	createServiceResponse(ExchangeService service, int responseIndex)	Initializes a new instance of the class.
IdFormat	getDestinationFormat()	Gets the destination format.
protected int	getExpectedResponseMessageCount()	Gets the expected response message count.
List<AlternateIdBase>	getIds()	Gets the 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	setDestinationFormat(IdFormat destinationFormat)	Sets the destination format.
protected void	validate()	Validate request.
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, writeAttributesToXml, writeBodyToXml, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

ConvertIdRequest

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

createServiceResponse

protected ConvertIdResponse createServiceResponse(ExchangeService service,
                                                  int responseIndex)

Initializes a new instance of the class.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<ConvertIdResponse>

Parameters:

service - the service

responseIndex - the response index

Returns:

the convert id response

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<ServiceResponseCollection<ConvertIdResponse>>

Returns:

XML element name.

getResponseMessageXmlElementName

protected String getResponseMessageXmlElementName()

Gets the name of the response message XML element.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<ConvertIdResponse>

Returns:

XML element name.

getExpectedResponseMessageCount

protected int getExpectedResponseMessageCount()

Gets the expected response message count.

Specified by:

getExpectedResponseMessageCount in class MultiResponseServiceRequest<ConvertIdResponse>

Returns:

Number of expected response messages.

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<ServiceResponseCollection<ConvertIdResponse>>

Returns:

XML element name.

validate

protected void validate()
                 throws Exception

Validate request.

Overrides:

validate in class ServiceRequestBase<ServiceResponseCollection<ConvertIdResponse>>

Throws:

Exception - the exception

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws XMLStreamException,
                                  ServiceXmlSerializationException

Writes XML elements.

Specified by:

writeElementsToXml in class ServiceRequestBase<ServiceResponseCollection<ConvertIdResponse>>

Parameters:

writer - the writer

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<ConvertIdResponse>>

Returns:

Earliest Exchange version in which this request is supported.

getDestinationFormat

public IdFormat getDestinationFormat()

Gets the destination format.

Returns:

the destination format

setDestinationFormat

public void setDestinationFormat(IdFormat destinationFormat)

Sets the destination format.

Parameters:

destinationFormat - the new destination format

getIds

public List<AlternateIdBase> getIds()

Gets the ids.

Returns:

the ids