offapi/com/sun/star/configuration/backend/UpdatableLayer.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: UpdatableLayer.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
  31 #ifndef __com_sun_star_configuration_backend_UpdatableLayer_idl__
  32 #define __com_sun_star_configuration_backend_UpdatableLayer_idl__
  33
  34 #ifndef __com_sun_star_configuration_backend_Layer_idl__
  35 #include <com/sun/star/configuration/backend/Layer.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_configuration_backend_XUpdatableLayer_idl__
  39 #include <com/sun/star/configuration/backend/XUpdatableLayer.idl>
  40 #endif
  41
  42 //==============================================================================
  43
  44 module com { module sun { module star { module configuration { module backend {
  45
  46 //==============================================================================
  47
  48 /**
  49   provides read/write access to a configuration data layer.
  50
  51   <p>A layer contains the configuration setting changes to be performed
  52   on a default layer (or schema) to obtain the values of those settings
  53   for a given entity and component.
  54   </p>
  55   <p>An updatable layer can be read or replaced with another layer.
  56   </p>
  57
  58   @since OOo 1.1.2
  59   */
  60 published service UpdatableLayer
  61 {
  62     //--------------------------------------------------------------------------
  63
  64     /**
  65         handles read access to the contents of the layer.
  66
  67         <p> If the implementation supports
  68          <type scope="com::sun::star::util">XTimeStamped</type>,
  69          then after executing <member>XUpdatableLayer::replaceWith()</member>
  70          the timestamp will be the one for the replaced contents and
  71          if reading after updates is supported the next read will reproduce the
  72          replaced data.
  73         </p>
  74       */
  75     service Layer ;
  76
  77     //--------------------------------------------------------------------------
  78
  79     /**
  80       provides write access to the contents of the layer.
  81
  82        <p> Depending of the actual type (simple, i.e pure <type>XLayer</type> or
  83        composite, i.e <type>XCompositeLayer</type>) of the current layer and
  84        the provided replacement layer, the operation performed
  85        by <member>XUpdatableLayer::replaceWith()</member>, will vary.
  86        </p>
  87        <p> For the different current/replacement layer combinations, we have:
  88        <dl>
  89            <dt>Simple/Simple<dt>
  90            <dd>the provided layer's contents replace the current one's.</dd>
  91
  92            <dt>Composite/Composite<dt>
  93            <dd>all layers (main and sub) present in the
  94                provided layer are used to replace the corresponding current
  95                layer contents. Sublayers present in the current layer but
  96                not in the provided one are left untouched. Sublayers present
  97                in the provided layer but not in the current one are added to
  98                the current layer.
  99             </dd>
 100
 101            <dt>Simple/Composite<dt>
 102            <dd>the main layer and sublayers of the provided layer
 103                are merged into one whose contents replace the current layer.
 104            </dd>
 105
 106            <dt>Composite/Simple<dt>
 107            <dd>the provided layer is split into a composite one whose contents
 108                are then used to replace the current layer as described above.
 109            </dd>
 110
 111        </dl>
 112        <em> Not all implementations of <type>XUpdatableLayer</type>
 113             support conversions of the replacement layer.
 114             In such a case the sublayers of the provided layer may be ignored
 115             or all simple data be merged into the main layer.
 116        </em>
 117        </p>
 118       */
 119     interface XUpdatableLayer ;
 120
 121     //--------------------------------------------------------------------------
 122
 123 } ;
 124
 125 //==============================================================================
 126
 127 } ; } ; } ; } ; } ;
 128
 129 #endif
 130