Package microsoft.exchange.webservices.data.autodiscover.response

Class GetUserSettingsResponse

java.lang.Object

microsoft.exchange.webservices.data.autodiscover.response.AutodiscoverResponse

microsoft.exchange.webservices.data.autodiscover.response.GetUserSettingsResponse

public final class GetUserSettingsResponse
extends AutodiscoverResponse

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

Constructor Summary

Constructors

Constructor	Description
GetUserSettingsResponse()	Initializes a new instance of the GetUserSettingsResponse class.

Method Summary

Modifier and Type	Method	Description
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.
void	loadFromXml(EwsXmlReader reader, String endElementName)	Loads response from XML.
protected void	loadUserSettingsFromXml(EwsXmlReader reader)	Loads from XML.
void	setRedirectTarget(String value)	Sets the redirectionTarget (URL or email address).
void	setSettings(Map<UserSettingName,Object> settings)	Sets the requested settings for the user.
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.autodiscover.response.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 GetUserSettingsResponse 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

public 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

public void setRedirectTarget(String value)

Sets the redirectionTarget (URL or email address).

Parameters:

value - redirect target value

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.

Parameters:

settings - settings map

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.

Parameters:

value - user setting errors

loadFromXml

public void loadFromXml(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(EwsXmlReader reader)
                                throws Exception

Loads from XML.

Parameters:

reader - The reader.

Throws:

Exception - the exception