microsoft.exchange.webservices.data
Class AlternateIdBase

java.lang.Object
  extended by microsoft.exchange.webservices.data.AlternateIdBase
Direct Known Subclasses:
AlternateId, AlternatePublicFolderId

public abstract class AlternateIdBase
extends java.lang.Object

Represents the base class for Id expressed in a specific format.


Constructor Summary
protected AlternateIdBase()
          Initializes a new instance of the class.
protected AlternateIdBase(IdFormat format)
          Initializes a new instance of the class.
 
Method Summary
 IdFormat getFormat()
          Gets the format in which the Id in expressed.
protected abstract  java.lang.String getXmlElementName()
          Gets the name of the XML element.
protected  void internalValidate()
          Validate this instance.
protected  void loadAttributesFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
          Loads the attributes from XML.
 void setFormat(IdFormat format)
          Sets the format.
 void validate()
          Validates this instance.
protected  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, toString, wait, wait, wait
 

Constructor Detail

AlternateIdBase

protected AlternateIdBase()
Initializes a new instance of the class.


AlternateIdBase

protected AlternateIdBase(IdFormat format)
Initializes a new instance of the class.

Parameters:
format - the format
Method Detail

getFormat

public IdFormat getFormat()
Gets the format in which the Id in expressed.

Returns:
the format

setFormat

public void setFormat(IdFormat format)
Sets the format.

Parameters:
format - the new format

getXmlElementName

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

Returns:
XML element name.

writeAttributesToXml

protected 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

loadAttributesFromXml

protected void loadAttributesFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                              throws java.lang.Exception
Loads the attributes from XML.

Parameters:
reader - the reader
Throws:
java.lang.Exception - the exception

writeToXml

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

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

internalValidate

protected void internalValidate()
                         throws java.lang.Exception
Validate this instance.

Throws:
java.lang.Exception

validate

public void validate()
              throws java.lang.Exception
Validates this instance.

Throws:
java.lang.Exception