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

Class GetUserConfigurationRequest

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

microsoft.exchange.webservices.data.core.request.GetUserConfigurationRequest

public class GetUserConfigurationRequest
extends MultiResponseServiceRequest<GetUserConfigurationResponse>

The Class GetUserConfigurationRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected GetUserConfigurationResponse	createServiceResponse(ExchangeService service, int responseIndex)	Creates the service response.
protected int	getExpectedResponseMessageCount()	Gets the expected response message count.
protected ExchangeVersion	getMinimumRequiredServerVersion()	Gets the request version.
protected String	getName()	Gets the name.
protected FolderId	getParentFolderId()	Gets the parent folder Id.
protected EnumSet<UserConfigurationProperties>	getProperties()	Gets the property.
protected String	getResponseMessageXmlElementName()	Gets the name of the response message XML element.
protected String	getResponseXmlElementName()	Gets the name of the response XML element.
protected UserConfiguration	getUserConfiguration()	Gets the user configuration.
String	getXmlElementName()	Gets the name of the XML element.
void	setName(String name)	Sets the name.
void	setParentFolderId(FolderId parentFolderId)	Sets the parent folder id.
void	setProperties(EnumSet<UserConfigurationProperties> properties)	Sets the property.
void	setUserConfiguration(UserConfiguration userConfiguration)	Sets the user configuration.
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

GetUserConfigurationRequest

public GetUserConfigurationRequest(ExchangeService service)
                            throws Exception

Initializes a new instance of the class.

Parameters:

service - the service

Throws:

Exception

Method Detail

validate

protected void validate()
                 throws ServiceLocalException,
                        Exception

Validate request.

Overrides:

validate in class ServiceRequestBase<ServiceResponseCollection<GetUserConfigurationResponse>>

Throws:

ServiceLocalException - the service local exception

Exception - the exception

createServiceResponse

protected GetUserConfigurationResponse createServiceResponse(ExchangeService service,
                                                             int responseIndex)
                                                      throws Exception

Creates the service response.

Specified by:

createServiceResponse in class MultiResponseServiceRequest<GetUserConfigurationResponse>

Parameters:

service - the service

responseIndex - the response index

Returns:

Service response.

Throws:

Exception - the exception

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<ServiceResponseCollection<GetUserConfigurationResponse>>

Returns:

Earliest Exchange version in which this request is supported.

getExpectedResponseMessageCount

protected int getExpectedResponseMessageCount()

Gets the expected response message count.

Specified by:

getExpectedResponseMessageCount in class MultiResponseServiceRequest<GetUserConfigurationResponse>

Returns:

Number of expected response messages.

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<ServiceResponseCollection<GetUserConfigurationResponse>>

Returns:

XML element name

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<ServiceResponseCollection<GetUserConfigurationResponse>>

Returns:

XML element name

getResponseMessageXmlElementName

protected String getResponseMessageXmlElementName()

Gets the name of the response message XML element.

Specified by:

getResponseMessageXmlElementName in class MultiResponseServiceRequest<GetUserConfigurationResponse>

Returns:

XML element name

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Writes XML elements.

Specified by:

writeElementsToXml in class ServiceRequestBase<ServiceResponseCollection<GetUserConfigurationResponse>>

Parameters:

writer - the writer

Throws:

Exception - the exception

getName

protected String getName()

Gets the name.

Returns:

the name

setName

public void setName(String name)

Sets the name.

Parameters:

name - the new name

getParentFolderId

protected FolderId getParentFolderId()

Gets the parent folder Id.

Returns:

the parent folder id

setParentFolderId

public void setParentFolderId(FolderId parentFolderId)

Sets the parent folder id.

Parameters:

parentFolderId - the new parent folder id

getUserConfiguration

protected UserConfiguration getUserConfiguration()

Gets the user configuration.

Returns:

the user configuration

setUserConfiguration

public void setUserConfiguration(UserConfiguration userConfiguration)

Sets the user configuration.

Parameters:

userConfiguration - the new user configuration

getProperties

protected EnumSet<UserConfigurationProperties> getProperties()

Gets the property.

Returns:

the property

setProperties

public void setProperties(EnumSet<UserConfigurationProperties> properties)

Sets the property.

Parameters:

properties - the new property