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    
024    package microsoft.exchange.webservices.data.core.response;
025    
026    import microsoft.exchange.webservices.data.core.EwsServiceXmlReader;
027    import microsoft.exchange.webservices.data.core.XmlElementNames;
028    import microsoft.exchange.webservices.data.core.enumeration.misc.XmlNamespace;
029    import microsoft.exchange.webservices.data.property.complex.RuleCollection;
030    
031    /**
032     * Represents the response to a GetInboxRules operation.
033     */
034    public final class GetInboxRulesResponse extends ServiceResponse {
035      /**
036       * Rule collection.
037       */
038      private RuleCollection ruleCollection;
039    
040      /**
041       * Initializes a new instance of the {@link GetInboxRulesResponse} class.
042       */
043      public GetInboxRulesResponse() {
044        super();
045        this.ruleCollection = new RuleCollection();
046      }
047    
048      /**
049       * Reads response elements from XML.
050       *
051       * @param reader The reader.
052       */
053      @Override
054      protected void readElementsFromXml(EwsServiceXmlReader reader)
055          throws Exception {
056        reader.read();
057        this.ruleCollection.setOutlookRuleBlobExists(reader.
058            readElementValue(Boolean.class,
059                XmlNamespace.Messages,
060                XmlElementNames.OutlookRuleBlobExists));
061        reader.read();
062        if (reader.isStartElement(XmlNamespace.NotSpecified, XmlElementNames.InboxRules)) {
063          this.ruleCollection.loadFromXml(reader,
064              XmlNamespace.NotSpecified,
065              XmlElementNames.InboxRules);
066        }
067      }
068    
069      /**
070       * Gets the rule collection in the response.
071       */
072      public RuleCollection getRules() {
073        return this.ruleCollection;
074      }
075    }
076