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.availability.Suggestion;
030    
031    import java.util.ArrayList;
032    import java.util.Collection;
033    
034    /**
035     * Represents the base response class to subscription creation operations.
036     */
037    public final class SuggestionsResponse extends ServiceResponse {
038    
039      /**
040       * The day suggestions.
041       */
042      private Collection<Suggestion> daySuggestions = new ArrayList<Suggestion>();
043    
044      /**
045       * Initializes a new instance of the SuggestionsResponse class.
046       */
047      public SuggestionsResponse() {
048        super();
049      }
050    
051      /**
052       * Loads the suggested days from XML.
053       *
054       * @param reader the reader
055       * @throws Exception the exception
056       */
057      public void loadSuggestedDaysFromXml(EwsServiceXmlReader reader)
058          throws Exception {
059        reader.readStartElement(XmlNamespace.Messages,
060            XmlElementNames.SuggestionDayResultArray);
061    
062        do {
063          reader.read();
064    
065          if (reader.isStartElement(XmlNamespace.Types,
066              XmlElementNames.SuggestionDayResult)) {
067            Suggestion daySuggestion = new Suggestion();
068    
069            daySuggestion.loadFromXml(reader, reader.getLocalName());
070    
071            this.daySuggestions.add(daySuggestion);
072          }
073        } while (!reader.isEndElement(XmlNamespace.Messages,
074            XmlElementNames.SuggestionDayResultArray));
075      }
076    
077      /**
078       * Gets a list of suggested days.
079       *
080       * @return the suggestions
081       */
082      public Collection<Suggestion> getSuggestions() {
083        return this.daySuggestions;
084      }
085    }