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

Class ResolveNamesRequest

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

microsoft.exchange.webservices.data.core.request.ResolveNamesRequest

public final class ResolveNamesRequest
extends MultiResponseServiceRequest<ResolveNamesResponse>

Represents a ResolveNames request.

Constructor Summary

Constructors

Constructor	Description
ResolveNamesRequest(ExchangeService service)	Initializes a new instance of the class.

Method Summary

Modifier and Type	Method	Description
protected ResolveNamesResponse	createServiceResponse(ExchangeService service, int responseIndex)	Creates the service response.
PropertySet	getContactDataPropertySet()	Gets or sets the PropertySet for Contact Data
protected int	getExpectedResponseMessageCount()	Gets the expected response message count.
protected ExchangeVersion	getMinimumRequiredServerVersion()	Gets the request version.
String	getNameToResolve()	Gets the name to resolve.
FolderIdWrapperList	getParentFolderIds()	Gets the parent folder ids.
protected String	getResponseMessageXmlElementName()	Gets the name of the response message XML element.
protected String	getResponseXmlElementName()	Gets the name of the response XML element.
boolean	getReturnFullContactData()	Gets a value indicating whether to return full contact data or not.
ResolveNameSearchLocation	getSearchLocation()	Gets the search location.
String	getXmlElementName()	Gets the name of the XML element.
void	setContactDataPropertySet(PropertySet propertySet)	Gets or sets the PropertySet for Contact Data The PropertySet
void	setNameToResolve(String nameToResolve)	Sets the name to resolve.
void	setReturnFullContactData(boolean returnFullContactData)	Sets the return full contact data.
void	setSearchLocation(ResolveNameSearchLocation searchLocation)	Sets the search location.
protected void	validate()	Asserts the valid.
protected void	writeAttributesToXml(EwsServiceXmlWriter writer)	Writes the attribute to XML.
protected void	writeElementsToXml(EwsServiceXmlWriter writer)	Writes the attribute 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

ResolveNamesRequest

public ResolveNamesRequest(ExchangeService service)
                    throws Exception

Initializes a new instance of the class.

Parameters:

service - the service

Throws:

Exception

Method Detail

validate

protected void validate()
                 throws Exception

Asserts the valid.

Overrides:

validate in class ServiceRequestBase<ServiceResponseCollection<ResolveNamesResponse>>

Throws:

Exception - the exception

createServiceResponse

protected ResolveNamesResponse createServiceResponse(ExchangeService service,
                                                     int responseIndex)

Creates the service response.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<ResolveNamesResponse>

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

Returns:

XML element name

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<ServiceResponseCollection<ResolveNamesResponse>>

Returns:

XML element name

getResponseMessageXmlElementName

protected String getResponseMessageXmlElementName()

Gets the name of the response message XML element.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<ResolveNamesResponse>

Returns:

XML element name

getExpectedResponseMessageCount

protected int getExpectedResponseMessageCount()

Gets the expected response message count.

Specified by:

getExpectedResponseMessageCount in class MultiResponseServiceRequest<ResolveNamesResponse>

Returns:

Number of expected response messages

writeAttributesToXml

protected void writeAttributesToXml(EwsServiceXmlWriter writer)
                             throws ServiceXmlSerializationException

Writes the attribute to XML.

Overrides:

writeAttributesToXml in class ServiceRequestBase<ServiceResponseCollection<ResolveNamesResponse>>

Parameters:

writer - the writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Writes the attribute to XML.

Specified by:

writeElementsToXml in class ServiceRequestBase<ServiceResponseCollection<ResolveNamesResponse>>

Parameters:

writer - the writer

Throws:

Exception - the exception

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<ResolveNamesResponse>>

Returns:

Earliest Exchange version in which this request is supported.

getNameToResolve

public String getNameToResolve()

Gets the name to resolve.

Returns:

the name to resolve

setNameToResolve

public void setNameToResolve(String nameToResolve)

Sets the name to resolve.

Parameters:

nameToResolve - the new name to resolve

getReturnFullContactData

public boolean getReturnFullContactData()

Gets a value indicating whether to return full contact data or not. "true" if should return full contact data; otherwise, "false".

Returns:

the return full contact data

setReturnFullContactData

public void setReturnFullContactData(boolean returnFullContactData)

Sets the return full contact data.

Parameters:

returnFullContactData - the new return full contact data

getSearchLocation

public ResolveNameSearchLocation getSearchLocation()

Gets the search location.

Returns:

the search location

setSearchLocation

public void setSearchLocation(ResolveNameSearchLocation searchLocation)

Sets the search location.

Parameters:

searchLocation - the new search location

getParentFolderIds

public FolderIdWrapperList getParentFolderIds()

Gets the parent folder ids.

Returns:

the parent folder ids

setContactDataPropertySet

public void setContactDataPropertySet(PropertySet propertySet)

Gets or sets the PropertySet for Contact Data The PropertySet

getContactDataPropertySet

public PropertySet getContactDataPropertySet()

Gets or sets the PropertySet for Contact Data

Returns:

The PropertySet