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.exception.service.local;
025    
026    import microsoft.exchange.webservices.data.property.definition.PropertyDefinitionBase;
027    
028    /**
029     * Represents an error that occurs when an operation on a property fails.
030     */
031    public class ServiceObjectPropertyException extends PropertyException {
032    
033      /**
034       * Constant serialized ID used for compatibility.
035       */
036      private static final long serialVersionUID = 1L;
037    
038      /**
039       * The property definition.
040       */
041      private PropertyDefinitionBase propertyDefinition;
042    
043      /**
044       * ServiceObjectPropertyException constructor.
045       *
046       * @param propertyDefinition The definition of the property that is at the origin of the
047       *                           exception.
048       */
049      public ServiceObjectPropertyException(
050          PropertyDefinitionBase propertyDefinition) {
051        super(propertyDefinition.getPrintableName());
052        this.propertyDefinition = propertyDefinition;
053      }
054    
055      /**
056       * ServiceObjectPropertyException constructor.
057       *
058       * @param message            Error message text.
059       * @param propertyDefinition The definition of the property that is at the origin of the
060       *                           exception.
061       */
062      public ServiceObjectPropertyException(String message,
063          PropertyDefinitionBase propertyDefinition) {
064        super(message, propertyDefinition.getPrintableName());
065        this.propertyDefinition = propertyDefinition;
066      }
067    
068      /**
069       * ServiceObjectPropertyException constructor.
070       *
071       * @param message            Error message text.
072       * @param propertyDefinition The definition of the property that is at the origin of the
073       *                           exception.
074       * @param innerException     the inner exception
075       */
076      public ServiceObjectPropertyException(String message,
077          PropertyDefinitionBase propertyDefinition,
078          Exception innerException) {
079        super(message, propertyDefinition.getPrintableName(), innerException);
080        this.propertyDefinition = propertyDefinition;
081      }
082    
083      /**
084       * The definition of the property that is at the origin of the exception.
085       *
086       * @return The definition of the property.
087       */
088      public PropertyDefinitionBase getPropertyDefinition() {
089        return propertyDefinition;
090      }
091    
092    }