microsoft.exchange.webservices.data.AlternateId Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of exchange-ws-api Show documentation
The source came from http://archive.msdn.microsoft.com/ewsjavaapi Support for Maven has been added.
The newest version!
/**************************************************************************
 * copyright file="AlternateId.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the AlternateId.java.
 **************************************************************************/
package microsoft.exchange.webservices.data;

/**
 * Represents an Id expressed in a specific format.
 */
public class AlternateId extends AlternateIdBase {

	/**
	 * Name of schema type used for AlternateId.
	 */
	protected final static String SchemaTypeName = "AlternateIdType";

	/**
	 * Id.
	 */
	private String id;

	/**
	 * SMTP address of the mailbox that the id belongs to.
	 */
	private String mailbox;

	/**
	 * Initializes a new instance of the class.
	 */
	public AlternateId() {
		super();
	}

	/**
	 * Initializes a new instance of the class.
	 * 
	 * @param format
	 *            the format
	 * @param id
	 *            the id
	 * @param mailbox
	 *            the mailbox
	 */
	public AlternateId(IdFormat format, String id, String mailbox) {
		super(format);
		this.setUniqueId(id);
		this.setMailbox(mailbox);	
	}

	/**
    * Initializes a new instance of the AlternateId class.
    * @param format The format the Id is expressed in.
    * @param id The Id.
    * @param mailbox The SMTP address of the mailbox that the Id belongs to.
    * @param isArchive Primary (false) or archive (true) mailbox.
    */
    public AlternateId(
        IdFormat format,
        String id,
        String mailbox,
        boolean isArchive) {
    	super(format);
        this.setUniqueId(id);
        this.setMailbox(mailbox);
        this.setIsArchive(isArchive);
    }
	/**
	 * Gets the Id.
	 * 
	 * @return the unique id
	 */
	public String getUniqueId() {
		return this.id;
	}

	/**
	 * Sets the unique id.
	 * 
	 * @param id
	 *            the new unique id
	 */
	public void setUniqueId(String id) {
		this.id = id;
	}

	/**
	 * Gets the mailbox to which the Id belongs.
	 * 
	 * @return the mailbox
	 */
	public String getMailbox() {
		return this.mailbox;
	}

	/**
	 * Sets the mailbox.
	 * 
	 * @param mailbox
	 *            the new mailbox
	 */
	public void setMailbox(String mailbox) {
		this.mailbox = mailbox;
	}

	/**
	 * Gets the type (primary or archive) mailbox to which the Id belongs.
	 * 
	 * @return the isArchive
	 */
	private boolean isArchive;
	public boolean getIsArchive() {
		return this.isArchive;
	}

	/**
	 * Sets the type (primary or archive) mailbox to which the Id belongs.
	 * 
	 * @param isArchive
	 *            the new isArchive
	 */
	public void setIsArchive(boolean isArchive) {
		this.isArchive = isArchive;
	}
	/**
	 * Gets the name of the XML element.
	 * 
	 * @return XML element name.
	 */
	@Override
	protected String getXmlElementName() {
		return XmlElementNames.AlternateId;
	}

	/**
	 * Gets the name of the XML element.
	 * 
	 * @param writer
	 *            the writer
	 * @throws ServiceXmlSerializationException
	 *             the service xml serialization exception
	 */
	@Override
	protected void writeAttributesToXml(EwsServiceXmlWriter writer)
			throws ServiceXmlSerializationException {
		super.writeAttributesToXml(writer);
		writer.writeAttributeValue(XmlAttributeNames.Id, this.getUniqueId());
		writer.writeAttributeValue(XmlAttributeNames.Mailbox,
				this.getMailbox());
				//.getMailbox() == null || this.getMailbox().isEmpty()) ? ""
				//: this.getMailbox());
		if(this.getIsArchive())
		{
			writer.writeAttributeValue(XmlAttributeNames.IsArchive, true);
		}

	}

	/**
	 * Gets the name of the XML element.
	 * 
	 * @param reader
	 *            the reader
	 * @throws Exception//
	 *             the exception
	 */
	@Override
	protected void loadAttributesFromXml(EwsServiceXmlReader reader)
			throws Exception {
		super.loadAttributesFromXml(reader);

		this.setUniqueId(reader.readAttributeValue(XmlAttributeNames.Id));
		this.setMailbox(reader.readAttributeValue(XmlAttributeNames.Mailbox));
		String isArchive = reader.readAttributeValue(
				XmlAttributeNames.IsArchive);
       
        if(!(isArchive==null || isArchive.isEmpty())) 
		{
            this.isArchive = reader.readAttributeValue(Boolean.class,
            		XmlAttributeNames.IsArchive);
        }
        else
        {
            this.isArchive = false;
        }
    }

	/**
	 * Validate this instance.
	 */
	@Override
    protected  void internalValidate() throws Exception
    {
        EwsUtilities.validateParam(this.getMailbox(), "mailbox");
    }
	}