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.sync;
025
026import microsoft.exchange.webservices.data.core.service.folder.Folder;
027import microsoft.exchange.webservices.data.core.exception.service.local.ServiceLocalException;
028import microsoft.exchange.webservices.data.property.complex.FolderId;
029import microsoft.exchange.webservices.data.property.complex.ServiceId;
030
031/**
032 * Represents a change on a folder as returned by a synchronization operation.
033 */
034public final class FolderChange extends Change {
035  /**
036   * Initializes a new instance of FolderChange.
037   */
038  public FolderChange() {
039    super();
040  }
041
042  /**
043   * Creates a FolderId instance.
044   *
045   * @return A FolderId.
046   */
047  @Override public ServiceId createId() {
048    return new FolderId();
049  }
050
051  /**
052   * Gets the folder the change applies to. Folder is null when ChangeType
053   * is equal to ChangeType.Delete. In that case, use the FolderId property to
054   * retrieve the Id of the folder that was deleted.
055   *
056   * @return the folder
057   */
058  public Folder getFolder() {
059    return (Folder) this.getServiceObject();
060  }
061
062  /**
063   * Gets the folder the change applies to. Folder is null when ChangeType
064   * is equal to ChangeType.Delete. In that case, use the FolderId property to
065   * retrieve the Id of the folder that was deleted.
066   *
067   * @return the folder id
068   * @throws ServiceLocalException the service local exception
069   */
070  public FolderId getFolderId() throws ServiceLocalException {
071    return (FolderId) this.getId();
072  }
073
074}