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

java.lang.Object
  extended by microsoft.exchange.webservices.data.ComplexProperty
      extended by 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(java.lang.Class<TKey> cls)
          Initializes a new instance of the "DictionaryEntryProperty<TKey>" class.
protected DictionaryEntryProperty(java.lang.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, java.lang.String ownerDictionaryXmlElementName)
          Writes the set update to XML.
 
Methods inherited from class microsoft.exchange.webservices.data.ComplexProperty
addOnChangeEvent, canSetFieldValue, changed, clearChangeEvents, clearChangeLog, func, getNamespace, internalValidate, loadFromXml, loadFromXml, readTextValueFromXml, removeChangeEvent, setNamespace, tryReadElementFromXml, tryReadElementFromXmlToPatch, updateFromXml, updateFromXml, 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(java.lang.Class<TKey> cls)
Initializes a new instance of the "DictionaryEntryProperty<TKey>" class.


DictionaryEntryProperty

protected DictionaryEntryProperty(java.lang.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 java.lang.Exception
Reads the attributes from XML.

Overrides:
readAttributesFromXml in class ComplexProperty
Parameters:
reader - accepts EwsServiceXmlReader
Throws:
java.lang.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,
                                      java.lang.String ownerDictionaryXmlElementName)
                               throws javax.xml.stream.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:
javax.xml.stream.XMLStreamException - the xML stream exception
ServiceXmlSerializationException - the service xml serialization exception

writeDeleteUpdateToXml

protected boolean writeDeleteUpdateToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
                                         ServiceObject ewsObject)
                                  throws javax.xml.stream.XMLStreamException,
                                         ServiceXmlSerializationException
Writes the delete update to XML.

Parameters:
writer - The writer.
ewsObject - The ews object.
Returns:
True if update XML was written.
Throws:
javax.xml.stream.XMLStreamException - the xML stream exception
ServiceXmlSerializationException - the service xml serialization exception