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.enumeration.misc.error.ServiceError;
030import microsoft.exchange.webservices.data.core.exception.service.remote.ServiceResponseException;
031import microsoft.exchange.webservices.data.misc.NameResolutionCollection;
032
033/**
034 * Represents the response to a name resolution operation.
035 */
036public final class ResolveNamesResponse extends ServiceResponse {
037
038  /**
039   * The resolutions.
040   */
041  private NameResolutionCollection resolutions;
042
043  /**
044   * Initializes a new instance of the class.
045   *
046   * @param service the service
047   */
048  public ResolveNamesResponse(ExchangeService service) {
049    super();
050    EwsUtilities.ewsAssert(service != null, "ResolveNamesResponse.ctor", "service is null");
051
052    this.resolutions = new NameResolutionCollection(service);
053  }
054
055  /**
056   * Reads response elements from XML.
057   *
058   * @param reader the reader
059   * @throws Exception the exception
060   */
061  @Override
062  protected void readElementsFromXml(EwsServiceXmlReader reader)
063      throws Exception {
064    super.readElementsFromXml(reader);
065    this.resolutions.loadFromXml(reader);
066  }
067
068  /**
069   * Override base implementation so that API does not throw when name
070   * resolution fails to find a match. EWS returns an error in this case but
071   * the API will just return an empty NameResolutionCollection.
072   *
073   * @throws ServiceResponseException the service response exception
074   */
075  @Override
076  protected void internalThrowIfNecessary() throws ServiceResponseException {
077    if (this.getErrorCode() != ServiceError.ErrorNameResolutionNoResults) {
078      super.internalThrowIfNecessary();
079    }
080  }
081
082  /**
083   * Gets a list of name resolution suggestions.
084   *
085   * @return the resolutions
086   */
087  public NameResolutionCollection getResolutions() {
088    return this.resolutions;
089  }
090}