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;
025    
026    import microsoft.exchange.webservices.data.core.service.ServiceObject;
027    import microsoft.exchange.webservices.data.property.definition.PropertyDefinition;
028    
029    /**
030     * Interface defined for property that produce their own update serialization.
031     */
032    public interface ICustomXmlUpdateSerializer {
033    
034      /**
035       * Writes the update to XML.
036       *
037       * @param writer the writer
038       * @param ewsObject The ews object
039       * @param propertyDefinition property definition
040       * @return true if property generated serialization
041       * @throws Exception the exception
042       */
043      boolean writeSetUpdateToXml(EwsServiceXmlWriter writer,
044          ServiceObject ewsObject, PropertyDefinition propertyDefinition) throws Exception;
045    
046      /**
047       * Writes the deletion update to XML.
048       *
049       * @param writer    The writer.
050       * @param ewsObject The ews object.
051       * @return True if property generated serialization.
052       * @throws Exception the exception
053       */
054      boolean writeDeleteUpdateToXml(EwsServiceXmlWriter writer,
055          ServiceObject ewsObject) throws Exception;
056    }