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

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

/**
 * Represents the working hours for a specific time zone.
 * 
 */
public final class WorkingHours extends ComplexProperty {

	/** The time zone. */
	private TimeZoneDefinition timeZone;

	/** The days of the week. */
	private Collection daysOfTheWeek = 
		new ArrayList();

	/** The start time. */
	private long startTime;

	/** The end time. */
	private long endTime;

	/**
	 * Instantiates a new working hours.
	 */
	protected WorkingHours() {
		super();
	}

	/***
	 * Tries to read element from XML.
	 * 
	 * @param reader
	 *            accepts EwsServiceXmlReader
	 * @return True if element was read
	 * @throws Exception
	 *             throws Exception
	 */
	@Override
	protected boolean tryReadElementFromXml(EwsServiceXmlReader reader)
			throws Exception {
		if (reader.getLocalName().equals(XmlElementNames.TimeZone)) {
			LegacyAvailabilityTimeZone legacyTimeZone =
				new LegacyAvailabilityTimeZone();
			legacyTimeZone.loadFromXml(reader, reader.getLocalName());

			this.timeZone = legacyTimeZone.toTimeZoneInfo();

			return true;
		}
		if (reader.getLocalName().equals(XmlElementNames.WorkingPeriodArray)) {
			List workingPeriods = new ArrayList();

			do {
				reader.read();

				if (reader.isStartElement(XmlNamespace.Types,
						XmlElementNames.WorkingPeriod)) {
					WorkingPeriod workingPeriod = new WorkingPeriod();

					workingPeriod.loadFromXml(reader, reader.getLocalName());

					workingPeriods.add(workingPeriod);
				}
			} while (!reader.isEndElement(XmlNamespace.Types,
					XmlElementNames.WorkingPeriodArray));

			// Availability supports a structure that can technically represent
			// different working
			// times for each day of the week. This is apparently how the
			// information is stored in
			// Exchange. However, no client (Outlook, OWA) either will let you
			// specify different
			// working times for each day of the week, and Outlook won't either
			// honor that complex
			// structure if it happens to be in Exchange (OWA goes through XSO
			// which doesn't either
			// honor the structure).
			// So here we'll do what Outlook and OWA do: we'll use the start and
			// end times of the
			// first working period, but we'll use the week days of all the
			// periods.

			this.startTime = workingPeriods.get(0).getStartTime();
			this.endTime = workingPeriods.get(0).getEndTime();

			for (WorkingPeriod workingPeriod : workingPeriods) {
				for (DayOfTheWeek dayOfWeek : workingPeriods.get(0)
						.getDaysOfWeek()) {
					if (!this.daysOfTheWeek.contains(dayOfWeek)) {
						this.daysOfTheWeek.add(dayOfWeek);
					}
				}
			}

			return true;
		} else {
			return false;
		}

	}

	/**
	 * Gets the time zone to which the working hours apply.
	 * 
	 * @return the time zone
	 */
	public TimeZoneDefinition getTimeZone() {
		return timeZone;
	}

	/**
	 * Gets the working days of the attendees.
	 * 
	 * @return the days of the week
	 */
	public Collection getDaysOfTheWeek() {
		return daysOfTheWeek;
	}

	/**
	 * Gets the time of the day the attendee starts working.
	 * 
	 * @return the start time
	 */
	public long getStartTime() {
		return startTime;
	}

	/**
	 * Gets the time of the day the attendee stops working.
	 * 
	 * @return the end time
	 */
	public long getEndTime() {
		return endTime;
	}

}