microsoft.exchange.webservices.data
Class GetUserSettingsResponse

java.lang.Object
  microsoft.exchange.webservices.data.AutodiscoverResponse
      microsoft.exchange.webservices.data.GetUserSettingsResponse

public final class GetUserSettingsResponse
extends AutodiscoverResponse

Represents the response to a GetUsersSettings call for an individual user.

Constructor Summary

GetUserSettingsResponse()
Initializes a new instance of the class.

Method Summary

String	getRedirectTarget() Gets the redirectionTarget (URL or email address).
Map<UserSettingName,Object>	getSettings() Gets the requested settings for the user.
String	getSmtpAddress() Gets the SMTP address this response applies to.
Collection<UserSettingError>	getUserSettingErrors() Gets error information for settings that could not be returned.
protected void	loadFromXml(microsoft.exchange.webservices.data.EwsXmlReader reader, String endElementName) Loads response from XML.
protected void	loadUserSettingsFromXml(microsoft.exchange.webservices.data.EwsXmlReader reader) Loads from XML.
protected void	setRedirectTarget(String value) Sets the redirectionTarget (URL or email address).
void	setSettings(Map<UserSettingName,Object> settings) sets the requested settings for the user.
protected void	setSmtpAddress(String value) Sets the smtp address.
protected void	setUserSettingErrors(Collection<UserSettingError> value) sets the requested settings for the user.
<T> boolean	tryGetSettingValue(Class<T> cls, UserSettingName setting, OutParam<T> value) Tries the get the user setting value.

Methods inherited from class microsoft.exchange.webservices.data.AutodiscoverResponse

getErrorCode, getErrorMessage, getRedirectionUrl, setErrorCode, setErrorMessage, setRedirectionUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

GetUserSettingsResponse

public GetUserSettingsResponse()

Initializes a new instance of the class.

Method Detail

tryGetSettingValue

public <T> boolean tryGetSettingValue(Class<T> cls,
                                      UserSettingName setting,
                                      OutParam<T> value)

Tries the get the user setting value.

Parameters:

cls - Type of user setting.

setting - The setting.

value - The setting value.

Returns:

True if setting was available.

getSmtpAddress

public String getSmtpAddress()

Gets the SMTP address this response applies to.

Returns:

the smtp address

setSmtpAddress

protected void setSmtpAddress(String value)

Sets the smtp address.

Parameters:

value - the new smtp address

getRedirectTarget

public String getRedirectTarget()

Gets the redirectionTarget (URL or email address).

Returns:

the redirect target

setRedirectTarget

protected void setRedirectTarget(String value)

Sets the redirectionTarget (URL or email address).

getSettings

public Map<UserSettingName,Object> getSettings()

Gets the requested settings for the user.

Returns:

the settings

setSettings

public void setSettings(Map<UserSettingName,Object> settings)

sets the requested settings for the user.

getUserSettingErrors

public Collection<UserSettingError> getUserSettingErrors()

Gets error information for settings that could not be returned.

Returns:

the user setting errors

setUserSettingErrors

protected void setUserSettingErrors(Collection<UserSettingError> value)

sets the requested settings for the user.

loadFromXml

protected void loadFromXml(microsoft.exchange.webservices.data.EwsXmlReader reader,
                           String endElementName)
                    throws Exception

Loads response from XML.

Overrides:

loadFromXml in class AutodiscoverResponse

Parameters:

reader - The reader.

endElementName - End element name.

Throws:

Exception - the exception

loadUserSettingsFromXml

protected void loadUserSettingsFromXml(microsoft.exchange.webservices.data.EwsXmlReader reader)
                                throws Exception

Loads from XML.

Parameters:

reader - The reader.

Throws:

Exception - the exception