OccurrenceInfo.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.property.complex;

import microsoft.exchange.webservices.data.core.EwsServiceXmlReader;
import microsoft.exchange.webservices.data.core.XmlElementNames;

import java.util.Date;

/**
 * Encapsulates information on the occurrence of a recurring appointment.
 */
public final class OccurrenceInfo extends ComplexProperty {

  /**
   * The item id.
   */
  private ItemId itemId;

  /**
   * The start.
   */
  private Date start;

  /**
   * The end.
   */
  private Date end;

  /**
   * The original start.
   */
  private Date originalStart;

  /**
   * Initializes a new instance of the OccurrenceInfo class.
   */
  public OccurrenceInfo() {
  }

  /**
   * Tries to read element from XML.
   *
   * @param reader the reader
   * @return true, if successful
   * @throws Exception the exception
   */
  public boolean tryReadElementFromXml(EwsServiceXmlReader reader)
      throws Exception {
    if (reader.getLocalName().equals(XmlElementNames.ItemId)) {

      this.itemId = new ItemId();
      this.itemId.loadFromXml(reader, reader.getLocalName());
      return true;
    } else if (reader.getLocalName().equals(XmlElementNames.Start)) {

      this.start = reader.readElementValueAsDateTime();
      return true;
    } else if (reader.getLocalName().equals(XmlElementNames.End)) {

      this.end = reader.readElementValueAsDateTime();
      return true;
    } else if (reader.getLocalName().equals(XmlElementNames.OriginalStart)) {

      this.originalStart = reader.readElementValueAsDateTime();
      return true;
    } else {

      return false;
    }
  }

  /**
   * Gets the Id of the occurrence.
   *
   * @return the item id
   */
  public ItemId getItemId() {
    return itemId;
  }

  /**
   * Gets the start date and time of the occurrence.
   *
   * @return the start
   */
  public Date getStart() {
    return start;
  }

  /**
   * Gets the end date and time of the occurrence.
   *
   * @return the end
   */
  public Date getEnd() {
    return end;
  }

  /**
   * Gets the original start date and time of the occurrence.
   *
   * @return the original start
   */
  public Date getOriginalStart() {
    return originalStart;
  }

}