FolderEvent.java

/*
 * The MIT License
 * Copyright (c) 2012 Microsoft Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package microsoft.exchange.webservices.data.notification;

import microsoft.exchange.webservices.data.core.EwsServiceXmlReader;
import microsoft.exchange.webservices.data.core.XmlElementNames;
import microsoft.exchange.webservices.data.core.enumeration.notification.EventType;
import microsoft.exchange.webservices.data.core.enumeration.misc.XmlNamespace;
import microsoft.exchange.webservices.data.property.complex.FolderId;

import java.util.Date;

/**
 * Represents an event that applies to a folder.
 */
public class FolderEvent extends NotificationEvent {

  /**
   * The folder id.
   */
  private FolderId folderId;

  /**
   * The old folder id.
   */
  private FolderId oldFolderId;

  /**
   * The new number of unread messages. This is is only meaningful when
   * EventType is equal to EventType.Modified. For all other event types, it's
   * null.
   */
  private int unreadCount;

  /**
   * Initializes a new instance.
   *
   * @param eventType the event type
   * @param timestamp the timestamp
   */
  protected FolderEvent(EventType eventType, Date timestamp) {
    super(eventType, timestamp);
  }

  /**
   * Load from XML.
   *
   * @param reader the reader
   * @throws Exception the exception
   */
  protected void internalLoadFromXml(EwsServiceXmlReader reader)
      throws Exception {
    super.internalLoadFromXml(reader);

    this.folderId = new FolderId();
    this.folderId.loadFromXml(reader, reader.getLocalName());

    reader.read();

    setParentFolderId(new FolderId());
    getParentFolderId().loadFromXml(reader, XmlElementNames.ParentFolderId);

    switch (getEventType()) {
      case Moved:
      case Copied:
        reader.read();

        this.oldFolderId = new FolderId();
        this.oldFolderId.loadFromXml(reader, reader.getLocalName());

        reader.read();

        setParentFolderId(new FolderId());
        getParentFolderId().loadFromXml(reader, reader.getLocalName());
        break;

      case Modified:
        reader.read();
        if (reader.isStartElement()) {
          reader.ensureCurrentNodeIsStartElement(XmlNamespace.Types,
              XmlElementNames.UnreadCount);
          String str = reader.readValue();
          this.unreadCount = Integer.parseInt(str);
        }
        break;

      default:
        break;
    }
  }

  /**
   * Gets the Id of the folder this event applies to.
   *
   * @return folderId
   */
  public FolderId getFolderId() {
    return folderId;
  }

  /**
   * gets the Id of the folder that was moved or copied. OldFolderId is only
   * meaningful when EventType is equal to either EventType.Moved or
   * EventType.Copied. For all other event types, OldFolderId is null.
   *
   * @return oldFolderId
   */
  public FolderId getOldFolderId() {
    return oldFolderId;
  }

  /**
   * Gets the new number of unread messages. This is is only meaningful when
   * EventType is equal to EventType.Modified. For all other event types,
   * UnreadCount is null.
   *
   * @return unreadCount
   */
  public int getUnreadCount() {
    return unreadCount;
  }

}