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.PropertySet;
027import microsoft.exchange.webservices.data.core.XmlElementNames;
028import microsoft.exchange.webservices.data.core.service.folder.Folder;
029import microsoft.exchange.webservices.data.sync.FolderChange;
030
031/**
032 * Represents the response to a folder synchronization operation.
033 */
034public final class SyncFolderHierarchyResponse extends
035    SyncResponse<Folder, FolderChange> {
036
037  /**
038   * Represents the response to a folder synchronization operation.
039   *
040   * @param propertySet the property set
041   */
042  public SyncFolderHierarchyResponse(PropertySet propertySet) {
043    super(propertySet);
044  }
045
046  /**
047   * Gets the name of the includes last in range XML element.
048   *
049   * @return XML element name.
050   */
051  @Override
052  protected String getIncludesLastInRangeXmlElementName() {
053    return XmlElementNames.IncludesLastFolderInRange;
054  }
055
056  /**
057   * Creates a folder change instance.
058   *
059   * @return FolderChange instance
060   */
061  @Override
062  protected FolderChange createChangeInstance() {
063    return new FolderChange();
064  }
065
066  /**
067   * Gets a value indicating whether this request returns full or summary property.
068   * "true" if summary property only; otherwise, "false".
069   *
070   * @return the summary property only
071   */
072  @Override
073  protected boolean getSummaryPropertiesOnly() {
074    return false;
075  }
076}