Package microsoft.exchange.webservices.data.misc.id

Class AlternateIdBase

java.lang.Object

microsoft.exchange.webservices.data.misc.id.AlternateIdBase

All Implemented Interfaces:

ISelfValidate

Direct Known Subclasses:

AlternateId, AlternatePublicFolderId

public abstract class AlternateIdBase
extends Object
implements ISelfValidate

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
IdFormat	getFormat()	Gets the format in which the Id in expressed.
protected abstract String	getXmlElementName()	Gets the name of the XML element.
protected void	internalValidate()	Validate this instance.
void	loadAttributesFromXml(EwsServiceXmlReader reader)	Loads the attribute from XML.
void	setFormat(IdFormat format)	Sets the format.
void	validate()	Validates this instance.
protected void	writeAttributesToXml(EwsServiceXmlWriter writer)	Writes the attribute to XML.
void	writeToXml(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 String getXmlElementName()

Gets the name of the XML element.

Returns:

XML element name.

writeAttributesToXml

protected void writeAttributesToXml(EwsServiceXmlWriter writer)
                             throws ServiceXmlSerializationException

Writes the attribute to XML.

Parameters:

writer - the writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

loadAttributesFromXml

public void loadAttributesFromXml(EwsServiceXmlReader reader)
                           throws Exception

Loads the attribute from XML.

Parameters:

reader - the reader

Throws:

Exception - the exception

writeToXml

public void writeToXml(EwsServiceXmlWriter writer)
                throws ServiceXmlSerializationException,
                       XMLStreamException

Writes to XML.

Parameters:

writer - the writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

XMLStreamException - the XML stream exception

internalValidate

protected void internalValidate()
                         throws Exception

Validate this instance.

Throws:

Exception

validate

public void validate()
              throws Exception

Validates this instance.

Specified by:

validate in interface ISelfValidate

Throws:

Exception

ServiceValidationException - the service validation exception