microsoft.exchange.webservices.data
Class AlternateId

java.lang.Object
  extended by microsoft.exchange.webservices.data.AlternateIdBase
      extended by microsoft.exchange.webservices.data.AlternateId

public class AlternateId
extends AlternateIdBase

Represents an Id expressed in a specific format.


Field Summary
protected static java.lang.String SchemaTypeName
          Name of schema type used for AlternateId.
 
Constructor Summary
AlternateId()
          Initializes a new instance of the class.
AlternateId(IdFormat format, java.lang.String id, java.lang.String mailbox)
          Initializes a new instance of the class.
AlternateId(IdFormat format, java.lang.String id, java.lang.String mailbox, boolean isArchive)
          Initializes a new instance of the AlternateId class.
 
Method Summary
 boolean getIsArchive()
           
 java.lang.String getMailbox()
          Gets the mailbox to which the Id belongs.
 java.lang.String getUniqueId()
          Gets the Id.
protected  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)
          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(java.lang.String mailbox)
          Sets the mailbox.
 void setUniqueId(java.lang.String id)
          Sets the unique id.
protected  void writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          Gets the name of the XML element.
 
Methods inherited from class microsoft.exchange.webservices.data.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

protected static final java.lang.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,
                   java.lang.String id,
                   java.lang.String mailbox)
Initializes a new instance of the class.

Parameters:
format - the format
id - the id
mailbox - the mailbox

AlternateId

public AlternateId(IdFormat format,
                   java.lang.String id,
                   java.lang.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 java.lang.String getUniqueId()
Gets the Id.

Returns:
the unique id

setUniqueId

public void setUniqueId(java.lang.String id)
Sets the unique id.

Parameters:
id - the new unique id

getMailbox

public java.lang.String getMailbox()
Gets the mailbox to which the Id belongs.

Returns:
the mailbox

setMailbox

public void setMailbox(java.lang.String mailbox)
Sets the mailbox.

Parameters:
mailbox - the new mailbox

getIsArchive

public boolean getIsArchive()

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 java.lang.String getXmlElementName()
Gets the name of the XML element.

Specified by:
getXmlElementName in class AlternateIdBase
Returns:
XML element name.

writeAttributesToXml

protected void writeAttributesToXml(microsoft.exchange.webservices.data.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

protected void loadAttributesFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                              throws java.lang.Exception
Gets the name of the XML element.

Overrides:
loadAttributesFromXml in class AlternateIdBase
Parameters:
reader - the reader
Throws:
Exception// - the exception
java.lang.Exception - the exception

internalValidate

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

Overrides:
internalValidate in class AlternateIdBase
Throws:
java.lang.Exception