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

Go to download
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.
There is a newer version: 1.1.5.2
/**************************************************************************
 * copyright file="FindItemResponse.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the FindItemResponse.java.
 **************************************************************************/
package microsoft.exchange.webservices.data;

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

import javax.xml.stream.XMLStreamException;

/**
 * 
 * Represents the response to a item search operation.
 * 
 * @param 
 *            The type of items that the opeartion returned.
 */
public final class FindItemResponse
		 extends ServiceResponse {

	/** The results. */
	private FindItemsResults results;

	/** The is grouped. */
	private boolean isGrouped;

	/** The grouped find results. */
	private GroupedFindItemsResults groupedFindResults;

	/** The property set. */
	private PropertySet propertySet;

	/**
	 * Initializes a new instance of the FindItemResponse class.
	 * 
	 * @param isGrouped
	 *            if set to true if grouped.
	 * @param propertySet
	 *            The property Set
	 */
	protected FindItemResponse(boolean isGrouped, PropertySet propertySet) {
		super();
		this.isGrouped = isGrouped;
		this.propertySet = propertySet;

		EwsUtilities.EwsAssert(this.propertySet != null,
				"FindItemResponse.ctor", "PropertySet should not be null");
	}

	/**
	 * Reads response elements from XML.
	 * 
	 * @param reader
	 *            ,The reader
	 * @throws Exception
	 *             the exception
	 */
	@SuppressWarnings("unchecked")
	@Override
	protected void readElementsFromXml(EwsServiceXmlReader reader)
			throws Exception {
		reader.readStartElement(XmlNamespace.Messages,
				XmlElementNames.RootFolder);

		int totalItemsInView = reader.readAttributeValue(Integer.class,
				XmlAttributeNames.TotalItemsInView);
		boolean moreItemsAvailable = !reader.readAttributeValue(Boolean.class,
				XmlAttributeNames.IncludesLastItemInRange);

		// Ignore IndexedPagingOffset attribute if moreItemsAvailable is false.
		Integer nextPageOffset = moreItemsAvailable ? reader
				.readNullableAttributeValue(Integer.class,
						XmlAttributeNames.IndexedPagingOffset) : null;

		if (!this.isGrouped) {
			this.results = new FindItemsResults();
			this.results.setTotalCount(totalItemsInView);
			this.results.setNextPageOffset(nextPageOffset);
			this.results.setMoreAvailable(moreItemsAvailable);
			internalReadItemsFromXml(reader, this.propertySet, this.results
					.getItems());
		} else {
			this.groupedFindResults = new GroupedFindItemsResults();
			this.groupedFindResults.setTotalCount(totalItemsInView);
			this.groupedFindResults.setNextPageOffset(nextPageOffset);
			this.groupedFindResults.setMoreAvailable(moreItemsAvailable);

			reader.readStartElement(XmlNamespace.Types, XmlElementNames.Groups);

			if (!reader.isEmptyElement()) {
				do {
					reader.read();

					if (reader.isStartElement(XmlNamespace.Types,
							XmlElementNames.GroupedItems)) {
						String groupIndex = reader.readElementValue(
								XmlNamespace.Types, XmlElementNames.GroupIndex);

						ArrayList itemList = new ArrayList();
						internalReadItemsFromXml(reader, this.propertySet,
								itemList);

						reader.readEndElement(XmlNamespace.Types,
								XmlElementNames.GroupedItems);

						this.groupedFindResults.getItemGroups().add(
								new ItemGroup(groupIndex, itemList));
					}
				} while (!reader.isEndElement(XmlNamespace.Types,
						XmlElementNames.Groups));
			} else {
				reader.read();
			}
		}

		reader
				.readEndElement(XmlNamespace.Messages,
						XmlElementNames.RootFolder);
	}

	/**
	 * Read items from XML.
	 * 
	 * @param reader
	 *            The reader
	 * @param propertySet
	 *            The property set
	 * @param destinationList
	 *            The list in which to add the read items.
	 * @throws XMLStreamException
	 *             the xML stream exception
	 * @throws ServiceXmlDeserializationException
	 *             the service xml deserialization exception
	 * @throws Exception
	 *             the exception
	 */
	private void internalReadItemsFromXml(EwsServiceXmlReader reader,
			PropertySet propertySet, List destinationList)
			throws XMLStreamException, ServiceXmlDeserializationException,
			Exception {
		EwsUtilities.EwsAssert(destinationList != null,
				"FindItemResponse.InternalReadItemsFromXml",
				"destinationList is null.");

		reader.readStartElement(XmlNamespace.Types, XmlElementNames.Items);
		if (!reader.isEmptyElement()) {
			do {
				reader.read();

				if (reader.getNodeType().nodeType == XMLNodeType.START_ELEMENT) {
					Item item = EwsUtilities.createEwsObjectFromXmlElementName(
							Item.class, reader.getService(), reader
									.getLocalName());

					if (item == null) {
						reader.skipCurrentElement();
					} else {
						item.loadFromXml(reader, true, /* clearPropertyBag */
						propertySet, true /* summaryPropertiesOnly */);

						destinationList.add((TItem) item);
					}
				}
			} while (!reader.isEndElement(XmlNamespace.Types,
					XmlElementNames.Items));
		} else {
			reader.read();
		}

	}

	/**
	 * Gets a grouped list of items matching the specified search criteria that
	 * were found in Exchange. ItemGroups is null if the search operation did
	 * not specify grouping options.
	 * 
	 * @return the grouped find results
	 */
	public GroupedFindItemsResults getGroupedFindResults() {
		return groupedFindResults;
	}

	/**
	 * Gets the results of the search operation.
	 * 
	 * @return the results
	 */
	public FindItemsResults getResults() {
		return results;
	}

}