microsoft.exchange.webservices.data.misc

Class UserConfiguration

java.lang.Object

microsoft.exchange.webservices.data.misc.UserConfiguration

public class UserConfiguration
extends Object

Represents an object that can be used to store user-defined configuration settings.

Constructor Summary

Constructors

Constructor and Description
UserConfiguration(ExchangeService service) Initializes a new instance of class.
UserConfiguration(ExchangeService service, EnumSet<UserConfigurationProperties> requestedProperties) Initializes a new instance of class.

Method Summary

Modifier and Type	Method and Description
static UserConfiguration	bind(ExchangeService service, String name, FolderId parentFolderId, UserConfigurationProperties properties) Binds to an existing user configuration and loads the specified property.
static UserConfiguration	bind(ExchangeService service, String name, WellKnownFolderName parentFolderName, UserConfigurationProperties properties) Binds to an existing user configuration and loads the specified property.
void	delete() Deletes the user configuration.
byte[]	getBinaryData() Gets the binary data of the user configuration.
UserConfigurationDictionary	getDictionary() Gets the dictionary of the user configuration.
boolean	getIsDirty() Gets a value indicating whether this user configuration has been modified.
ItemId	getItemId() Gets the Id of the user configuration.
String	getName() Gets the name of the user configuration.
FolderId	getParentFolderId() Gets the Id of the folder containing the user configuration.
byte[]	getXmlData() Gets the xml data of the user configuration.
void	load(UserConfigurationProperties properties) Loads the specified property on the user configuration.
void	loadFromXml(EwsServiceXmlReader reader) Loads from XML.
void	save(String name, FolderId parentFolderId) Saves the user configuration.
void	save(String name, WellKnownFolderName parentFolderName) Saves the user configuration.
void	setBinaryData(byte[] value) Sets the binary data.
void	setName(String value) Sets the name.
void	setParentFolderId(FolderId value) Sets the parent folder id.
void	setXmlData(byte[] value) Sets the xml data.
void	update() Updates the user configuration by applying local changes to the Exchange server.
void	writeToXml(EwsServiceXmlWriter writer, XmlNamespace xmlNamespace, String xmlElementName) Writes to XML.
static void	writeUserConfigurationNameToXml(EwsServiceXmlWriter writer, XmlNamespace xmlNamespace, String name, FolderId parentFolderId) Writes to Xml.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserConfiguration

public UserConfiguration(ExchangeService service)
                  throws Exception

Initializes a new instance of class.

Parameters:

service - The service to which the user configuration is bound.

Throws:

Exception - the exception

UserConfiguration

public UserConfiguration(ExchangeService service,
                         EnumSet<UserConfigurationProperties> requestedProperties)
                  throws Exception

Initializes a new instance of class.

Parameters:

service - The service to which the user configuration is bound.

requestedProperties - The property requested for this user configuration.

Throws:

Exception - the exception

Method Detail

writeUserConfigurationNameToXml

public static void writeUserConfigurationNameToXml(EwsServiceXmlWriter writer,
                                                   XmlNamespace xmlNamespace,
                                                   String name,
                                                   FolderId parentFolderId)
                                            throws Exception

Writes to Xml.

Parameters:

writer - The writer.

xmlNamespace - The XML namespace.

name - The user configuration name.

parentFolderId - The Id of the folder containing the user configuration.

Throws:

Exception - the exception

getName

public String getName()

Gets the name of the user configuration.

Returns:

the name

setName

public void setName(String value)

Sets the name.

Parameters:

value - the new name

getParentFolderId

public FolderId getParentFolderId()

Gets the Id of the folder containing the user configuration.

Returns:

the parent folder id

setParentFolderId

public void setParentFolderId(FolderId value)

Sets the parent folder id.

Parameters:

value - the new parent folder id

getItemId

public ItemId getItemId()

Gets the Id of the user configuration.

Returns:

the item id

getDictionary

public UserConfigurationDictionary getDictionary()

Gets the dictionary of the user configuration.

Returns:

the dictionary

getXmlData

public byte[] getXmlData()
                  throws PropertyException

Gets the xml data of the user configuration.

Returns:

the xml data

Throws:

PropertyException - the property exception

setXmlData

public void setXmlData(byte[] value)

Sets the xml data.

Parameters:

value - the new xml data

getBinaryData

public byte[] getBinaryData()
                     throws PropertyException

Gets the binary data of the user configuration.

Returns:

the binary data

Throws:

PropertyException - the property exception

setBinaryData

public void setBinaryData(byte[] value)

Sets the binary data.

Parameters:

value - the new binary data

getIsDirty

public boolean getIsDirty()

Gets a value indicating whether this user configuration has been modified.

Returns:

the checks if is dirty

bind

public static UserConfiguration bind(ExchangeService service,
                                     String name,
                                     FolderId parentFolderId,
                                     UserConfigurationProperties properties)
                              throws IndexOutOfBoundsException,
                                     Exception

Binds to an existing user configuration and loads the specified property. Calling this method results in a call to EWS.

Parameters:

service - The service to which the user configuration is bound.

name - The name of the user configuration.

parentFolderId - The Id of the folder containing the user configuration.

properties - The property to load.

Returns:

A user configuration instance.

Throws:

IndexOutOfBoundsException - the index out of bounds exception

Exception - the exception

bind

public static UserConfiguration bind(ExchangeService service,
                                     String name,
                                     WellKnownFolderName parentFolderName,
                                     UserConfigurationProperties properties)
                              throws IndexOutOfBoundsException,
                                     Exception

Binds to an existing user configuration and loads the specified property.

Parameters:

service - The service to which the user configuration is bound.

name - The name of the user configuration.

parentFolderName - The name of the folder containing the user configuration.

properties - The property to load.

Returns:

A user configuration instance.

Throws:

IndexOutOfBoundsException - the index out of bounds exception

Exception - the exception

save

public void save(String name,
                 FolderId parentFolderId)
          throws Exception

Saves the user configuration. Calling this method results in a call to EWS.

Parameters:

name - The name of the user configuration.

parentFolderId - The Id of the folder in which to save the user configuration.

Throws:

Exception - the exception

save

public void save(String name,
                 WellKnownFolderName parentFolderName)
          throws Exception

Saves the user configuration. Calling this method results in a call to EWS.

Parameters:

name - The name of the user configuration.

parentFolderName - The name of the folder in which to save the user configuration.

Throws:

Exception - the exception

update

public void update()
            throws Exception

Updates the user configuration by applying local changes to the Exchange server. Calling this method results in a call to EWS

Throws:

Exception - the exception

delete

public void delete()
            throws Exception

Deletes the user configuration. Calling this method results in a call to EWS.

Throws:

Exception - the exception

load

public void load(UserConfigurationProperties properties)
          throws Exception

Loads the specified property on the user configuration. Calling this method results in a call to EWS.

Parameters:

properties - The property to load.

Throws:

Exception - the exception

writeToXml

public void writeToXml(EwsServiceXmlWriter writer,
                       XmlNamespace xmlNamespace,
                       String xmlElementName)
                throws Exception

Writes to XML.

Parameters:

writer - The writer.

xmlNamespace - The XML namespace.

xmlElementName - Name of the XML element.

Throws:

Exception - the exception

loadFromXml

public void loadFromXml(EwsServiceXmlReader reader)
                 throws Exception

Loads from XML.

Parameters:

reader - The reader.

Throws:

Exception - the exception