microsoft.exchange.webservices.data
Class PropertyDefinitionBase

java.lang.Object
  extended by microsoft.exchange.webservices.data.PropertyDefinitionBase
Direct Known Subclasses:
ExtendedPropertyDefinition, ServiceObjectPropertyDefinition

public abstract class PropertyDefinitionBase
extends java.lang.Object

Represents the base class for all property definitions.


Constructor Summary
protected PropertyDefinitionBase()
          * Initializes a new instance.
 
Method Summary
protected abstract  java.lang.String getPrintableName()
          Gets the property definition's printable name.
abstract  java.lang.Class getType()
          Gets the type of the property.
abstract  ExchangeVersion getVersion()
          Gets the minimum Exchange version that supports this property.
protected abstract  java.lang.String getXmlElementName()
          Gets the name of the XML element.
 java.lang.String toString()
           
protected static boolean tryLoadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader, OutParam<PropertyDefinitionBase> propertyDefinition)
          * Tries to load from XML.
protected abstract  void writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          * Writes the attributes to XML.
protected  void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          * Writes to XML.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PropertyDefinitionBase

protected PropertyDefinitionBase()
* Initializes a new instance.

Method Detail

tryLoadFromXml

protected static boolean tryLoadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader,
                                        OutParam<PropertyDefinitionBase> propertyDefinition)
                                 throws java.lang.Exception
* Tries to load from XML.

Parameters:
reader - The reader.
propertyDefinition - The property definition.
Returns:
True if property was loaded.
Throws:
java.lang.Exception - the exception

getXmlElementName

protected abstract java.lang.String getXmlElementName()
Gets the name of the XML element.

Returns:
XML element name.

writeAttributesToXml

protected abstract void writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                                      throws ServiceXmlSerializationException
* Writes the attributes to XML.

Parameters:
writer - The writer.
Throws:
ServiceXmlSerializationException - the service xml serialization exception

getVersion

public abstract ExchangeVersion getVersion()
Gets the minimum Exchange version that supports this property.

Returns:
The version.

getPrintableName

protected abstract java.lang.String getPrintableName()
Gets the property definition's printable name.

Returns:
The property definition's printable name.

getType

public abstract java.lang.Class getType()
Gets the type of the property.


writeToXml

protected void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                   throws javax.xml.stream.XMLStreamException,
                          ServiceXmlSerializationException
* Writes to XML.

Parameters:
writer - The writer.
Throws:
javax.xml.stream.XMLStreamException - the xML stream exception
ServiceXmlSerializationException - the service xml serialization exception

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object