microsoft.exchange.webservices.data
Class DictionaryEntryProperty<TKey>

java.lang.Object
  microsoft.exchange.webservices.data.ComplexProperty
      microsoft.exchange.webservices.data.DictionaryEntryProperty<TKey>

Type Parameters:

TKey - the generic type

Direct Known Subclasses:

EmailAddressEntry, ImAddressEntry, PhoneNumberEntry, PhysicalAddressEntry

public abstract class DictionaryEntryProperty<TKey>
extends ComplexProperty

Represents an entry of a DictionaryProperty object. All descendants of DictionaryEntryProperty must implement a parameterless constructor. That constructor does not have to be public. That constructor does not have to be public.

Constructor Summary

protected	DictionaryEntryProperty(Class<TKey> cls) Initializes a new instance of the "DictionaryEntryProperty<TKey>" class.
protected	DictionaryEntryProperty(Class<TKey> cls, TKey key) Initializes a new instance of the "DictionaryEntryProperty<TKey>" class.

Method Summary

protected TKey	getKey() Gets the key.
protected void	readAttributesFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) Reads the attributes from XML.
protected void	setKey(TKey value) Sets the key.
protected void	writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) Writes the attributes to XML.
protected boolean	writeDeleteUpdateToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, ServiceObject ewsObject) Writes the delete update to XML.
protected boolean	writeSetUpdateToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, ServiceObject ewsObject, String ownerDictionaryXmlElementName) Writes the set update to XML.

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

addOnChangeEvent, canSetFieldValue, changed, clearChangeEvents, clearChangeLog, getNamespace, internalValidate, loadFromXml, loadFromXml, readTextValueFromXml, removeChangeEvent, setNamespace, tryReadElementFromXml, validate, writeElementsToXml, writeToXml, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

DictionaryEntryProperty

protected DictionaryEntryProperty(Class<TKey> cls)

Initializes a new instance of the "DictionaryEntryProperty<TKey>" class.

DictionaryEntryProperty

protected DictionaryEntryProperty(Class<TKey> cls,
                                  TKey key)

Initializes a new instance of the "DictionaryEntryProperty<TKey>" class.

Parameters:

key - The key.

Method Detail

getKey

protected TKey getKey()

Gets the key.

Returns:

the key

setKey

protected void setKey(TKey value)

Sets the key.

Parameters:

value - the value to set

readAttributesFromXml

protected void readAttributesFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                              throws Exception

Reads the attributes from XML.

Overrides:

readAttributesFromXml in class ComplexProperty

Parameters:

reader - accepts EwsServiceXmlReader

Throws:

Exception - throws Exception

writeAttributesToXml

protected void writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                             throws ServiceXmlSerializationException

Writes the attributes to XML.

Overrides:

writeAttributesToXml in class ComplexProperty

Parameters:

writer - accepts EwsServiceXmlWriter

Throws:

ServiceXmlSerializationException - throws ServiceXmlSerializationException

writeSetUpdateToXml

protected boolean writeSetUpdateToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
                                      ServiceObject ewsObject,
                                      String ownerDictionaryXmlElementName)
                               throws XMLStreamException,
                                      ServiceXmlSerializationException

Writes the set update to XML.

Parameters:

writer - The writer.

ewsObject - The ews object.

ownerDictionaryXmlElementName - Name of the owner dictionary XML element.

Returns:

True if update XML was written.

Throws:

XMLStreamException - the xML stream exception

ServiceXmlSerializationException - the service xml serialization exception

writeDeleteUpdateToXml

protected boolean writeDeleteUpdateToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
                                         ServiceObject ewsObject)
                                  throws XMLStreamException,
                                         ServiceXmlSerializationException

Writes the delete update to XML.

Parameters:

writer - The writer.

ewsObject - The ews object.

Returns:

True if update XML was written.

Throws:

XMLStreamException - the xML stream exception

ServiceXmlSerializationException - the service xml serialization exception