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.ExchangeService;
029import microsoft.exchange.webservices.data.core.PropertySet;
030import microsoft.exchange.webservices.data.core.XmlElementNames;
031import microsoft.exchange.webservices.data.core.service.ServiceObject;
032import microsoft.exchange.webservices.data.core.service.folder.Folder;
033
034import java.util.List;
035
036/**
037 * Represents the response to an individual folder retrieval operation.
038 */
039public final class GetFolderResponse extends ServiceResponse implements
040                                                             IGetObjectInstanceDelegate<ServiceObject> {
041
042  /**
043   * The folder.
044   */
045  private Folder folder;
046
047  /**
048   * The property set.
049   */
050  private PropertySet propertySet;
051
052  /**
053   * Initializes a new instance of the GetFolderResponse class.
054   *
055   * @param folder      The folder.
056   * @param propertySet The property set from the request.
057   */
058  public GetFolderResponse(Folder folder, PropertySet propertySet) {
059    super();
060    this.folder = folder;
061    this.propertySet = propertySet;
062    EwsUtilities
063        .ewsAssert(this.propertySet != null, "GetFolderResponse.ctor", "PropertySet should not be null");
064  }
065
066  /**
067   * Reads response elements from XML.
068   *
069   * @param reader the reader
070   * @throws Exception the exception
071   */
072  @Override
073  protected void readElementsFromXml(EwsServiceXmlReader reader)
074      throws Exception {
075    super.readElementsFromXml(reader);
076    List<Folder> folders = reader.readServiceObjectsCollectionFromXml(
077        XmlElementNames.Folders, this, true, /* clearPropertyBag */
078        this.propertySet, /* requestedPropertySet */
079        false); /* summaryPropertiesOnly */
080    this.folder = folders.get(0);
081  }
082
083  /**
084   * Gets the object instance delegate.
085   *
086   * @param service        the service
087   * @param xmlElementName the xml element name
088   * @return the object instance delegate
089   * @throws Exception the exception
090   */
091  @Override
092  public ServiceObject getObjectInstanceDelegate(ExchangeService service,
093      String xmlElementName) throws Exception {
094    return this.getObjectInstance(service, xmlElementName);
095  }
096
097  /**
098   * Gets the folder instance.
099   *
100   * @param service        The service.
101   * @param xmlElementName Name of the XML element.
102   * @return folder
103   * @throws Exception the exception
104   */
105  private Folder getObjectInstance(ExchangeService service,
106      String xmlElementName) throws Exception {
107    if (this.getFolder() != null) {
108      return this.getFolder();
109    } else {
110      return EwsUtilities.createEwsObjectFromXmlElementName(Folder.class,
111          service, xmlElementName);
112    }
113  }
114
115  /**
116   * Gets the folder that was retrieved.
117   *
118   * @return folder
119   */
120  public Folder getFolder() {
121    return this.folder;
122  }
123
124}