001/*
002 * The MIT License
003 * Copyright (c) 2012 Microsoft Corporation
004 *
005 * Permission is hereby granted, free of charge, to any person obtaining a copy
006 * of this software and associated documentation files (the "Software"), to deal
007 * in the Software without restriction, including without limitation the rights
008 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
009 * copies of the Software, and to permit persons to whom the Software is
010 * furnished to do so, subject to the following conditions:
011 *
012 * The above copyright notice and this permission notice shall be included in
013 * all copies or substantial portions of the Software.
014 *
015 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
016 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
017 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
018 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
019 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
020 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
021 * THE SOFTWARE.
022 */
023
024package microsoft.exchange.webservices.data.core.response;
025
026import microsoft.exchange.webservices.data.core.EwsServiceXmlReader;
027import microsoft.exchange.webservices.data.core.EwsUtilities;
028import microsoft.exchange.webservices.data.core.XmlElementNames;
029import microsoft.exchange.webservices.data.core.service.item.Conversation;
030import microsoft.exchange.webservices.data.core.enumeration.misc.XmlNamespace;
031import microsoft.exchange.webservices.data.security.XmlNodeType;
032
033import java.util.ArrayList;
034import java.util.Collection;
035import java.util.List;
036
037/**
038 * Represents the response to a Conversation search operation.
039 */
040public final class FindConversationResponse extends ServiceResponse {
041  List<Conversation> conversations = new ArrayList<Conversation>();
042
043  /**
044   * Initializes a new instance of the FindConversationResponse class.
045   */
046  public FindConversationResponse() {
047    super();
048  }
049
050  /**
051   * Gets the results of the operation.
052   */
053  public Collection<Conversation> getConversations() {
054
055    return this.conversations;
056
057  }
058
059  /**
060   * Read Conversations from XML.
061   *
062   * @param reader The reader.
063   * @throws Exception
064   */
065  @Override
066  protected void readElementsFromXml(EwsServiceXmlReader reader)
067      throws Exception {
068    EwsUtilities.ewsAssert(conversations != null, "FindConversationResponse.ReadElementsFromXml",
069                           "conversations is null.");
070
071    reader.readStartElement(XmlNamespace.Messages,
072        XmlElementNames.Conversations);
073    if (!reader.isEmptyElement()) {
074      do {
075        reader.read();
076
077        if (reader.getNodeType().getNodeType() == XmlNodeType.START_ELEMENT) {
078          Conversation item = EwsUtilities.
079              createEwsObjectFromXmlElementName(Conversation.class,
080                  reader.getService(), reader.getLocalName());
081
082          if (item == null) {
083            reader.skipCurrentElement();
084          } else {
085            item.loadFromXml(
086                reader,
087                true, /* clearPropertyBag */
088                null,
089                false  /* summaryPropertiesOnly */);
090
091            conversations.add(item);
092          }
093        }
094      }
095      while (!reader.isEndElement(XmlNamespace.Messages,
096          XmlElementNames.Conversations));
097    }
098  }
099}