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.request;
025    
026    import microsoft.exchange.webservices.data.core.ExchangeService;
027    import microsoft.exchange.webservices.data.core.XmlElementNames;
028    import microsoft.exchange.webservices.data.core.enumeration.service.error.ServiceErrorHandling;
029    import microsoft.exchange.webservices.data.core.response.FindFolderResponse;
030    import microsoft.exchange.webservices.data.core.enumeration.misc.ExchangeVersion;
031    
032    /**
033     * Represents a FindFolder request.
034     */
035    public final class FindFolderRequest extends FindRequest<FindFolderResponse> {
036    
037      /**
038       * Initializes a new instance of the FindFolderRequest class.
039       *
040       * @param exchangeService   The Service
041       * @param errorHandlingMode Indicates how errors should be handled.
042       * @throws Exception
043       */
044      public FindFolderRequest(ExchangeService exchangeService, ServiceErrorHandling errorHandlingMode)
045          throws Exception {
046        super(exchangeService, errorHandlingMode);
047      }
048    
049      /**
050       * Creates the service response.
051       *
052       * @param service       The service
053       * @param responseIndex Index of the response. Service response.
054       * @return the find folder response
055       */
056      @Override
057      protected FindFolderResponse createServiceResponse(ExchangeService service,
058          int responseIndex) {
059        return new FindFolderResponse(this.getView().getPropertySetOrDefault());
060      }
061    
062      /**
063       * Gets the name of the XML element.
064       *
065       * @return XML element name.
066       */
067      @Override public String getXmlElementName() {
068        return XmlElementNames.FindFolder;
069      }
070    
071      /**
072       * Gets the name of the response XML element.
073       *
074       * @return XML element name.
075       */
076      @Override
077      protected String getResponseXmlElementName() {
078        return XmlElementNames.FindFolderResponse;
079      }
080    
081      /**
082       * Gets the name of the response message XML element.
083       *
084       * @return XML element name.
085       */
086      @Override
087      protected String getResponseMessageXmlElementName() {
088        return XmlElementNames.FindFolderResponseMessage;
089      }
090    
091      /**
092       * Gets the request version.
093       *
094       * @return Earliest Exchange version in which this request is supported.
095       */
096      @Override
097      protected ExchangeVersion getMinimumRequiredServerVersion() {
098        return ExchangeVersion.Exchange2007_SP1;
099      }
100    
101    }