offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: LayerUpdateMerger.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_configuration_backend_LayerUpdateMerger_idl__
  31 #define __com_sun_star_configuration_backend_LayerUpdateMerger_idl__
  32
  33 #ifndef __com_sun_star_lang_XInitialization_idl__
  34 #include <com/sun/star/lang/XInitialization.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__
  38 #include <com/sun/star/configuration/backend/XUpdateHandler.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module configuration { module backend {
  44
  45 //=============================================================================
  46
  47 /**
  48     applies updates to a configuration layer.
  49
  50     <p> The configuration layer data is read from a <type>XLayer</type>
  51     and the changed layer is provided as <type>XLayer</type> again or
  52     described to a <type>XLayerHandler</type>.
  53     </p>
  54
  55     @see com::sun::star::configuration::backend::UpdatableLayer
  56         Service describes a layer and accepts a changed layer..
  57
  58     @since OOo 1.1.2
  59 */
  60 published service LayerUpdateMerger
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** accepts events describing the changes.
  65       */
  66     interface com::sun::star::configuration::backend::XUpdateHandler ;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** allows initializing layer data source and target.
  71
  72         <p> Both source and target of the update can be provided by passing a
  73             <type>XUpdatableLayer</type> object. Alternatively they can be
  74             provided individually by providing a <type>XLayer</type> object as
  75             data source and an <type>XLayerHandler</type> object to receive the
  76             updated data.
  77         </p>
  78         <p> Implementations can provide more arguments to finetune the behavior.
  79             Such arguments are provided as
  80             <type scope="com::sun::star::beans">NamedValue</type>.
  81             Implementations should support the following named arguments:
  82         <dl>
  83             <dt><code>Overwrite</code> : <atom>boolean</atom></dt>
  84             <dd>If <FALSE/>, specifies that changes should be applied
  85                 only if the existing layer is empty.
  86             </dd>
  87             <dt><code>Truncate</code> : <atom>boolean</atom></dt>
  88             <dd>If <TRUE/> requests that changes should not be merged onto
  89                 existing data, but that the changes should be applied
  90                 to a layer that is completely empty.
  91             </dd>
  92         </dl>
  93         </p>
  94       */
  95     interface com::sun::star::lang::XInitialization ;
  96
  97     //-------------------------------------------------------------------------
  98 } ;
  99
 100 //=============================================================================
 101
 102 } ; } ; } ; } ; } ;
 103
 104 #endif