microsoft.exchange.webservices.data.core.response.GetInboxRulesResponse Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ews-java-api Show documentation

Exchange Web Services (EWS) Java API

There is a newer version: 2.15

/*
 * The MIT License
 * Copyright (c) 2012 Microsoft Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package microsoft.exchange.webservices.data.core.response;

import microsoft.exchange.webservices.data.core.EwsServiceXmlReader;
import microsoft.exchange.webservices.data.core.XmlElementNames;
import microsoft.exchange.webservices.data.core.enumeration.misc.XmlNamespace;
import microsoft.exchange.webservices.data.property.complex.RuleCollection;

/**
 * Represents the response to a GetInboxRules operation.
 */
public final class GetInboxRulesResponse extends ServiceResponse {
  /**
   * Rule collection.
   */
  private RuleCollection ruleCollection;

  /**
   * Initializes a new instance of the {@link GetInboxRulesResponse} class.
   */
  public GetInboxRulesResponse() {
    super();
    this.ruleCollection = new RuleCollection();
  }

  /**
   * Reads response elements from XML.
   *
   * @param reader The reader.
   */
  @Override
  protected void readElementsFromXml(EwsServiceXmlReader reader)
      throws Exception {
    reader.read();
    this.ruleCollection.setOutlookRuleBlobExists(reader.
        readElementValue(Boolean.class,
            XmlNamespace.Messages,
            XmlElementNames.OutlookRuleBlobExists));
    reader.read();
    if (reader.isStartElement(XmlNamespace.NotSpecified, XmlElementNames.InboxRules)) {
      this.ruleCollection.loadFromXml(reader,
          XmlNamespace.NotSpecified,
          XmlElementNames.InboxRules);
    }
  }

  /**
   * Gets the rule collection in the response.
   */
  public RuleCollection getRules() {
    return this.ruleCollection;
  }
}