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.EwsUtilities;
028    import microsoft.exchange.webservices.data.core.ExchangeService;
029    import microsoft.exchange.webservices.data.core.PropertySet;
030    import microsoft.exchange.webservices.data.core.XmlElementNames;
031    import microsoft.exchange.webservices.data.core.service.ServiceObject;
032    import microsoft.exchange.webservices.data.core.service.item.Item;
033    
034    import java.util.List;
035    
036    /**
037     * Represents a response to an individual item retrieval operation.
038     */
039    public final class GetItemResponse extends ServiceResponse implements
040                                                               IGetObjectInstanceDelegate<ServiceObject> {
041    
042      /**
043       * The item.
044       */
045      private Item item;
046    
047      /**
048       * The property set.
049       */
050      private PropertySet propertySet;
051    
052      /**
053       * Initializes a new instance of the class.
054       *
055       * @param item        the item
056       * @param propertySet the property set
057       */
058      public GetItemResponse(Item item, PropertySet propertySet) {
059        super();
060        this.item = item;
061        this.propertySet = propertySet;
062        EwsUtilities.ewsAssert(this.propertySet != null, "GetItemResponse.ctor", "PropertySet should not be null");
063      }
064    
065      /**
066       * Reads response elements from XML.
067       *
068       * @param reader the reader
069       * @throws InstantiationException the instantiation exception
070       * @throws IllegalAccessException the illegal access exception
071       * @throws Exception              the exception
072       */
073      protected void readElementsFromXml(EwsServiceXmlReader reader)
074          throws InstantiationException, IllegalAccessException, Exception {
075        super.readElementsFromXml(reader);
076    
077        List<Item> items = reader.readServiceObjectsCollectionFromXml(
078            XmlElementNames.Items, this,
079            true, /* clearPropertyBag */
080            this.propertySet, /* requestedPropertySet */
081            false); /* summaryPropertiesOnly */
082    
083        this.item = items.get(0);
084      }
085    
086      /**
087       * Gets Item instance.
088       *
089       * @param service        the service
090       * @param xmlElementName the xml element name
091       * @return Item
092       * @throws Exception the exception
093       */
094      private Item getObjectInstance(ExchangeService service,
095          String xmlElementName) throws Exception {
096        if (this.getItem() != null) {
097          return this.getItem();
098        } else {
099          return EwsUtilities.createEwsObjectFromXmlElementName(Item.class,
100              service, xmlElementName);
101    
102        }
103      }
104    
105      /**
106       * Gets the item that was retrieved.
107       *
108       * @return the item
109       */
110      public Item getItem() {
111        return this.item;
112      }
113    
114      /**
115       * Gets the object instance delegate.
116       *
117       * @param service        accepts ExchangeService
118       * @param xmlElementName accepts String
119       * @return Name
120       * @throws Exception throws exception
121       */
122      @Override
123      public ServiceObject getObjectInstanceDelegate(ExchangeService service,
124          String xmlElementName) throws Exception {
125        return getObjectInstance(service, xmlElementName);
126      }
127    }