microsoft.exchange.webservices.data.TimeSuggestion 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="TimeSuggestion.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the TimeSuggestion.java.
 **************************************************************************/
package microsoft.exchange.webservices.data;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;

/**
 * Represents an availability time suggestion.
 * 
 */
public final class TimeSuggestion extends ComplexProperty {

	/** The meeting time. */
	private Date meetingTime;

	/** The is work time. */
	private boolean isWorkTime;

	/** The quality. */
	private SuggestionQuality quality;

	/** The conflicts. */
	private Collection conflicts = new ArrayList();

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

	/**
	 * Tries to read element from XML.
	 * 
	 * @param reader
	 *            the reader
	 * @return True if appropriate element was read.
	 * @throws Exception
	 *             the exception
	 */
	@Override
	protected boolean tryReadElementFromXml(EwsServiceXmlReader reader)
			throws Exception {
		if (reader.getLocalName().equals(XmlElementNames.MeetingTime)) {
			this.meetingTime = reader
					.readElementValueAsUnbiasedDateTimeScopedToServiceTimeZone();
			return true;
		} else if (reader.getLocalName().equals(XmlElementNames.IsWorkTime)) {
			this.isWorkTime = reader.readElementValue(Boolean.class);
			return true;
		} else if (reader.getLocalName().equals(
				XmlElementNames.SuggestionQuality)) {
			this.quality = reader.readElementValue(SuggestionQuality.class);
			return true;
		} else if (reader.getLocalName().equals(
				XmlElementNames.AttendeeConflictDataArray)) {
			if (!reader.isEmptyElement()) {
				do {
					reader.read();

					if (reader.isStartElement()) {
						Conflict conflict = null;

						if (reader.getLocalName().equals(
								XmlElementNames.UnknownAttendeeConflictData)) {
							conflict = new Conflict(
									ConflictType.UnknownAttendeeConflict);
						} else if (reader
								.getLocalName()
								.equals(
										XmlElementNames.
										TooBigGroupAttendeeConflictData)) {
							conflict = new Conflict(
									ConflictType.GroupTooBigConflict);
						} else if (reader.getLocalName().equals(
								XmlElementNames.
								IndividualAttendeeConflictData)) {
							conflict = new Conflict(
									ConflictType.IndividualAttendeeConflict);
						} else if (reader.getLocalName().equals(
								XmlElementNames.GroupAttendeeConflictData)) {
							conflict = new Conflict(ConflictType.GroupConflict);
						} else {
							EwsUtilities
									.EwsAssert(
											false,
											"TimeSuggestion." +
											"TryReadElementFromXml",
											String
													.format(
															"The %s element name " +
															"does not map " +
															"to any AttendeeConflict " +
															"descendant.",
															reader
																	.getLocalName()));

							// The following line to please the compiler
						}
						conflict.loadFromXml(reader, reader.getLocalName());

						this.conflicts.add(conflict);
					}
				} while (!reader.isEndElement(XmlNamespace.Types,
						XmlElementNames.AttendeeConflictDataArray));
			}

			return true;
		} else {
			return false;
		}

	}

	/**
	 * Gets the suggested time.
	 * 
	 * @return the meeting time
	 */
	public Date getMeetingTime() {
		return meetingTime;
	}

	/**
	 * Gets a value indicating whether the suggested time is within working
	 * hours.
	 * 
	 * @return true, if is work time
	 */
	public boolean isWorkTime() {
		return isWorkTime;
	}

	/**
	 * Gets the quality of the suggestion.
	 * 
	 * @return the quality
	 */
	public SuggestionQuality getQuality() {
		return quality;
	}

	/**
	 * Gets a collection of conflicts at the suggested time.
	 * 
	 * @return the conflicts
	 */
	public Collection getConflicts() {
		return conflicts;
	}

}