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.misc;
025
026import microsoft.exchange.webservices.data.core.EwsServiceXmlWriter;
027import microsoft.exchange.webservices.data.core.service.folder.Folder;
028import microsoft.exchange.webservices.data.core.enumeration.misc.ExchangeVersion;
029import microsoft.exchange.webservices.data.core.exception.service.local.ServiceVersionException;
030
031/**
032 * Represents the abstraction of a folder Id.
033 */
034public abstract class AbstractFolderIdWrapper {
035
036  /**
037   * Obtains the Folder object associated with the wrapper.
038   *
039   * @return The Folder object associated with the wrapper.
040   */
041  public Folder getFolder() {
042    return null;
043  }
044
045  /**
046   * Initializes a new instance of AbstractFolderIdWrapper.
047   */
048  protected AbstractFolderIdWrapper() {
049  }
050
051  /**
052   * Writes the Id encapsulated in the wrapper to XML.
053   *
054   * @param writer the writer
055   * @throws Exception the exception
056   */
057  protected abstract void writeToXml(EwsServiceXmlWriter writer)
058      throws Exception;
059
060  /**
061   * Validates folderId against specified version.
062   *
063   * @param version the version
064   * @throws ServiceVersionException the service version exception
065   */
066  protected void validate(ExchangeVersion version)
067      throws ServiceVersionException {
068  }
069}