1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_configuration_backend_UpdatableLayer_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_configuration_backend_UpdatableLayer_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_configuration_backend_Layer_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/configuration/backend/Layer.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_configuration_backend_XUpdatableLayer_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/configuration/backend/XUpdatableLayer.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================== 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module configuration { module backend { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================== 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski/** 42*b1cdbd2cSJim Jagielski provides read/write access to a configuration data layer. 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski <p>A layer contains the configuration setting changes to be performed 45*b1cdbd2cSJim Jagielski on a default layer (or schema) to obtain the values of those settings 46*b1cdbd2cSJim Jagielski for a given entity and component. 47*b1cdbd2cSJim Jagielski </p> 48*b1cdbd2cSJim Jagielski <p>An updatable layer can be read or replaced with another layer. 49*b1cdbd2cSJim Jagielski </p> 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski @since OpenOffice 1.1.2 52*b1cdbd2cSJim Jagielski */ 53*b1cdbd2cSJim Jagielskipublished service UpdatableLayer 54*b1cdbd2cSJim Jagielski{ 55*b1cdbd2cSJim Jagielski //-------------------------------------------------------------------------- 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski /** 58*b1cdbd2cSJim Jagielski handles read access to the contents of the layer. 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski <p> If the implementation supports 61*b1cdbd2cSJim Jagielski <type scope="com::sun::star::util">XTimeStamped</type>, 62*b1cdbd2cSJim Jagielski then after executing <member>XUpdatableLayer::replaceWith()</member> 63*b1cdbd2cSJim Jagielski the timestamp will be the one for the replaced contents and 64*b1cdbd2cSJim Jagielski if reading after updates is supported the next read will reproduce the 65*b1cdbd2cSJim Jagielski replaced data. 66*b1cdbd2cSJim Jagielski </p> 67*b1cdbd2cSJim Jagielski */ 68*b1cdbd2cSJim Jagielski service Layer ; 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski //-------------------------------------------------------------------------- 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski /** 73*b1cdbd2cSJim Jagielski provides write access to the contents of the layer. 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski <p> Depending of the actual type (simple, i.e pure <type>XLayer</type> or 76*b1cdbd2cSJim Jagielski composite, i.e <type>XCompositeLayer</type>) of the current layer and 77*b1cdbd2cSJim Jagielski the provided replacement layer, the operation performed 78*b1cdbd2cSJim Jagielski by <member>XUpdatableLayer::replaceWith()</member>, will vary. 79*b1cdbd2cSJim Jagielski </p> 80*b1cdbd2cSJim Jagielski <p> For the different current/replacement layer combinations, we have: 81*b1cdbd2cSJim Jagielski <dl> 82*b1cdbd2cSJim Jagielski <dt>Simple/Simple<dt> 83*b1cdbd2cSJim Jagielski <dd>the provided layer's contents replace the current one's.</dd> 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski <dt>Composite/Composite<dt> 86*b1cdbd2cSJim Jagielski <dd>all layers (main and sub) present in the 87*b1cdbd2cSJim Jagielski provided layer are used to replace the corresponding current 88*b1cdbd2cSJim Jagielski layer contents. Sublayers present in the current layer but 89*b1cdbd2cSJim Jagielski not in the provided one are left untouched. Sublayers present 90*b1cdbd2cSJim Jagielski in the provided layer but not in the current one are added to 91*b1cdbd2cSJim Jagielski the current layer. 92*b1cdbd2cSJim Jagielski </dd> 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski <dt>Simple/Composite<dt> 95*b1cdbd2cSJim Jagielski <dd>the main layer and sublayers of the provided layer 96*b1cdbd2cSJim Jagielski are merged into one whose contents replace the current layer. 97*b1cdbd2cSJim Jagielski </dd> 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski <dt>Composite/Simple<dt> 100*b1cdbd2cSJim Jagielski <dd>the provided layer is split into a composite one whose contents 101*b1cdbd2cSJim Jagielski are then used to replace the current layer as described above. 102*b1cdbd2cSJim Jagielski </dd> 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski </dl> 105*b1cdbd2cSJim Jagielski <em> Not all implementations of <type>XUpdatableLayer</type> 106*b1cdbd2cSJim Jagielski support conversions of the replacement layer. 107*b1cdbd2cSJim Jagielski In such a case the sublayers of the provided layer may be ignored 108*b1cdbd2cSJim Jagielski or all simple data be merged into the main layer. 109*b1cdbd2cSJim Jagielski </em> 110*b1cdbd2cSJim Jagielski </p> 111*b1cdbd2cSJim Jagielski */ 112*b1cdbd2cSJim Jagielski interface XUpdatableLayer ; 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski //-------------------------------------------------------------------------- 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski} ; 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski//============================================================================== 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski} ; } ; } ; } ; } ; 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski#endif 123*b1cdbd2cSJim Jagielski 124