|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmicrosoft.exchange.webservices.data.UserConfiguration
public class UserConfiguration
Represents an object that can be used to store user-defined configuration settings.
Constructor Summary | |
---|---|
|
UserConfiguration(ExchangeService service)
Initializes a new instance of |
protected |
UserConfiguration(ExchangeService service,
java.util.EnumSet<UserConfigurationProperties> requestedProperties)
Initializes a new instance of |
Method Summary | |
---|---|
static UserConfiguration |
bind(ExchangeService service,
java.lang.String name,
FolderId parentFolderId,
UserConfigurationProperties properties)
Binds to an existing user configuration and loads the specified properties. |
static UserConfiguration |
bind(ExchangeService service,
java.lang.String name,
WellKnownFolderName parentFolderName,
UserConfigurationProperties properties)
Binds to an existing user configuration and loads the specified properties. |
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. |
java.lang.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 properties on the user configuration. |
protected void |
loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
Loads from XML. |
void |
save(java.lang.String name,
FolderId parentFolderId)
Saves the user configuration. |
void |
save(java.lang.String name,
WellKnownFolderName parentFolderName)
Saves the user configuration. |
void |
setBinaryData(byte[] value)
Sets the binary data. |
protected void |
setName(java.lang.String value)
Sets the name. |
protected 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. |
protected void |
writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
microsoft.exchange.webservices.data.XmlNamespace xmlNamespace,
java.lang.String xmlElementName)
Writes to XML. |
protected static void |
writeUserConfigurationNameToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
microsoft.exchange.webservices.data.XmlNamespace xmlNamespace,
java.lang.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 |
---|
public UserConfiguration(ExchangeService service) throws java.lang.Exception
service
- The service to which the user configuration is bound.
java.lang.Exception
- the exceptionprotected UserConfiguration(ExchangeService service, java.util.EnumSet<UserConfigurationProperties> requestedProperties) throws java.lang.Exception
service
- The service to which the user configuration is bound.requestedProperties
- The properties requested for this user configuration.
java.lang.Exception
- the exceptionMethod Detail |
---|
protected static void writeUserConfigurationNameToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, microsoft.exchange.webservices.data.XmlNamespace xmlNamespace, java.lang.String name, FolderId parentFolderId) throws java.lang.Exception
writer
- The writer.xmlNamespace
- The XML namespace.name
- The user configuration name.parentFolderId
- The Id of the folder containing the user configuration.
java.lang.Exception
- the exceptionpublic java.lang.String getName()
protected void setName(java.lang.String value)
value
- the new namepublic FolderId getParentFolderId()
protected void setParentFolderId(FolderId value)
value
- the new parent folder idpublic ItemId getItemId()
public UserConfigurationDictionary getDictionary()
public byte[] getXmlData() throws PropertyException
PropertyException
- the property exceptionpublic void setXmlData(byte[] value)
value
- the new xml datapublic byte[] getBinaryData() throws PropertyException
PropertyException
- the property exceptionpublic void setBinaryData(byte[] value)
value
- the new binary datapublic boolean getIsDirty()
public static UserConfiguration bind(ExchangeService service, java.lang.String name, FolderId parentFolderId, UserConfigurationProperties properties) throws java.lang.IndexOutOfBoundsException, java.lang.Exception
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 properties to load.
java.lang.IndexOutOfBoundsException
- the index out of bounds exception
java.lang.Exception
- the exceptionpublic static UserConfiguration bind(ExchangeService service, java.lang.String name, WellKnownFolderName parentFolderName, UserConfigurationProperties properties) throws java.lang.IndexOutOfBoundsException, java.lang.Exception
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 properties to load.
java.lang.IndexOutOfBoundsException
- the index out of bounds exception
java.lang.Exception
- the exceptionpublic void save(java.lang.String name, FolderId parentFolderId) throws java.lang.Exception
name
- The name of the user configuration.parentFolderId
- The Id of the folder in which to save the user configuration.
java.lang.Exception
- the exceptionpublic void save(java.lang.String name, WellKnownFolderName parentFolderName) throws java.lang.Exception
name
- The name of the user configuration.parentFolderName
- The name of the folder in which to save the user
configuration.
java.lang.Exception
- the exceptionpublic void update() throws java.lang.Exception
java.lang.Exception
- the exceptionpublic void delete() throws java.lang.Exception
java.lang.Exception
- the exceptionpublic void load(UserConfigurationProperties properties) throws java.lang.Exception
properties
- The properties to load.
java.lang.Exception
- the exceptionprotected void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, microsoft.exchange.webservices.data.XmlNamespace xmlNamespace, java.lang.String xmlElementName) throws java.lang.Exception
writer
- The writer.xmlNamespace
- The XML namespace.xmlElementName
- Name of the XML element.
java.lang.Exception
- the exceptionprotected void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) throws java.lang.Exception
reader
- The reader.
java.lang.Exception
- the exception
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |