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

Class AlternateId

java.lang.Object

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

microsoft.exchange.webservices.data.misc.id.AlternateId

All Implemented Interfaces:

ISelfValidate

public class AlternateId
extends AlternateIdBase

Represents an Id expressed in a specific format.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SchemaTypeName	Name of schema type used for AlternateId.

Constructor Summary

Constructors

Constructor	Description
AlternateId()	Initializes a new instance of the class.
AlternateId(IdFormat format, String id, String mailbox)	Initializes a new instance of the class.
AlternateId(IdFormat format, String id, String mailbox, boolean isArchive)	Initializes a new instance of the AlternateId class.

Method Summary

Modifier and Type	Method	Description
boolean	getIsArchive()	Gets the type (primary or archive) mailbox to which the Id belongs.
String	getMailbox()	Gets the mailbox to which the Id belongs.
String	getUniqueId()	Gets the Id.
protected String	getXmlElementName()	Gets the name of the XML element.
protected void	internalValidate()	Validate this instance.
void	loadAttributesFromXml(EwsServiceXmlReader reader)	Gets the name of the XML element.
void	setIsArchive(boolean isArchive)	Sets the type (primary or archive) mailbox to which the Id belongs.
void	setMailbox(String mailbox)	Sets the mailbox.
void	setUniqueId(String id)	Sets the unique id.
protected void	writeAttributesToXml(EwsServiceXmlWriter writer)	Gets the name of the XML element.

Methods inherited from class microsoft.exchange.webservices.data.misc.id.AlternateIdBase

getFormat, setFormat, validate, writeToXml

Methods inherited from class java.lang.Object

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

Field Detail

SchemaTypeName

public static final String SchemaTypeName

Name of schema type used for AlternateId.

See Also:

Constant Field Values

Constructor Detail

AlternateId

public AlternateId()

Initializes a new instance of the class.

AlternateId

public AlternateId(IdFormat format,
                   String id,
                   String mailbox)

Initializes a new instance of the class.

Parameters:

format - the format

id - the id

mailbox - the mailbox

AlternateId

public AlternateId(IdFormat format,
                   String id,
                   String mailbox,
                   boolean isArchive)

Initializes a new instance of the AlternateId class.

Parameters:

format - The format the Id is expressed in.

id - The Id.

mailbox - The SMTP address of the mailbox that the Id belongs to.

isArchive - Primary (false) or archive (true) mailbox.

Method Detail

getUniqueId

public String getUniqueId()

Gets the Id.

Returns:

the unique id

setUniqueId

public void setUniqueId(String id)

Sets the unique id.

Parameters:

id - the new unique id

getMailbox

public String getMailbox()

Gets the mailbox to which the Id belongs.

Returns:

the mailbox

setMailbox

public void setMailbox(String mailbox)

Sets the mailbox.

Parameters:

mailbox - the new mailbox

getIsArchive

public boolean getIsArchive()

Gets the type (primary or archive) mailbox to which the Id belongs.

setIsArchive

public void setIsArchive(boolean isArchive)

Sets the type (primary or archive) mailbox to which the Id belongs.

Parameters:

isArchive - the new isArchive

getXmlElementName

protected String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class AlternateIdBase

Returns:

XML element name.

writeAttributesToXml

protected void writeAttributesToXml(EwsServiceXmlWriter writer)
                             throws ServiceXmlSerializationException

Gets the name of the XML element.

Overrides:

writeAttributesToXml in class AlternateIdBase

Parameters:

writer - the writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

loadAttributesFromXml

public void loadAttributesFromXml(EwsServiceXmlReader reader)
                           throws Exception

Gets the name of the XML element.

Overrides:

loadAttributesFromXml in class AlternateIdBase

Parameters:

reader - the reader

Throws:

Exception - the exception

internalValidate

protected void internalValidate()
                         throws Exception

Validate this instance.

Overrides:

internalValidate in class AlternateIdBase

Throws:

Exception