1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28#ifndef __com_sun_star_configuration_backend_UpdatableLayer_idl__ 29#define __com_sun_star_configuration_backend_UpdatableLayer_idl__ 30 31#ifndef __com_sun_star_configuration_backend_Layer_idl__ 32#include <com/sun/star/configuration/backend/Layer.idl> 33#endif 34 35#ifndef __com_sun_star_configuration_backend_XUpdatableLayer_idl__ 36#include <com/sun/star/configuration/backend/XUpdatableLayer.idl> 37#endif 38 39//============================================================================== 40 41module com { module sun { module star { module configuration { module backend { 42 43//============================================================================== 44 45/** 46 provides read/write access to a configuration data layer. 47 48 <p>A layer contains the configuration setting changes to be performed 49 on a default layer (or schema) to obtain the values of those settings 50 for a given entity and component. 51 </p> 52 <p>An updatable layer can be read or replaced with another layer. 53 </p> 54 55 @since OOo 1.1.2 56 */ 57published service UpdatableLayer 58{ 59 //-------------------------------------------------------------------------- 60 61 /** 62 handles read access to the contents of the layer. 63 64 <p> If the implementation supports 65 <type scope="com::sun::star::util">XTimeStamped</type>, 66 then after executing <member>XUpdatableLayer::replaceWith()</member> 67 the timestamp will be the one for the replaced contents and 68 if reading after updates is supported the next read will reproduce the 69 replaced data. 70 </p> 71 */ 72 service Layer ; 73 74 //-------------------------------------------------------------------------- 75 76 /** 77 provides write access to the contents of the layer. 78 79 <p> Depending of the actual type (simple, i.e pure <type>XLayer</type> or 80 composite, i.e <type>XCompositeLayer</type>) of the current layer and 81 the provided replacement layer, the operation performed 82 by <member>XUpdatableLayer::replaceWith()</member>, will vary. 83 </p> 84 <p> For the different current/replacement layer combinations, we have: 85 <dl> 86 <dt>Simple/Simple<dt> 87 <dd>the provided layer's contents replace the current one's.</dd> 88 89 <dt>Composite/Composite<dt> 90 <dd>all layers (main and sub) present in the 91 provided layer are used to replace the corresponding current 92 layer contents. Sublayers present in the current layer but 93 not in the provided one are left untouched. Sublayers present 94 in the provided layer but not in the current one are added to 95 the current layer. 96 </dd> 97 98 <dt>Simple/Composite<dt> 99 <dd>the main layer and sublayers of the provided layer 100 are merged into one whose contents replace the current layer. 101 </dd> 102 103 <dt>Composite/Simple<dt> 104 <dd>the provided layer is split into a composite one whose contents 105 are then used to replace the current layer as described above. 106 </dd> 107 108 </dl> 109 <em> Not all implementations of <type>XUpdatableLayer</type> 110 support conversions of the replacement layer. 111 In such a case the sublayers of the provided layer may be ignored 112 or all simple data be merged into the main layer. 113 </em> 114 </p> 115 */ 116 interface XUpdatableLayer ; 117 118 //-------------------------------------------------------------------------- 119 120} ; 121 122//============================================================================== 123 124} ; } ; } ; } ; } ; 125 126#endif 127 128