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#ifndef __com_sun_star_configuration_ConfigurationUpdateAccess_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_configuration_ConfigurationUpdateAccess_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_configuration_ConfigurationAccess_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/configuration/ConfigurationAccess.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_configuration_SetUpdate_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/configuration/SetUpdate.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_configuration_GroupUpdate_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/configuration/GroupUpdate.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_configuration_UpdateRootElement_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/configuration/UpdateRootElement.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski//============================================================================= 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module configuration { 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski//============================================================================= 47*b1cdbd2cSJim Jagielski/** provides modifying access to a fragment of the configuration hierarchy. 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski <p>Extends <type>ConfigurationAccess</type> to support modifying values 50*b1cdbd2cSJim Jagielski or inserting and removing elements. 51*b1cdbd2cSJim Jagielski </p> 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski <p>Descendants of this service also implement this service 54*b1cdbd2cSJim Jagielski unless they are marked <em>read-only</em> (which is indicated by attribute 55*b1cdbd2cSJim Jagielski <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>), 56*b1cdbd2cSJim Jagielski in which case they only need implement <type>ConfigurationAccess</type>. 57*b1cdbd2cSJim Jagielski </p> 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski <p>The classification of implementations that is described for 60*b1cdbd2cSJim Jagielski <type>ConfigurationAccess</type> applies to implementations of this service 61*b1cdbd2cSJim Jagielski as well. Therefore an implementation will support one of several alternate 62*b1cdbd2cSJim Jagielski services describing its <em>Container</em> role and one of several alternate 63*b1cdbd2cSJim Jagielski services describing its <em>Element</em> role. These services are 64*b1cdbd2cSJim Jagielski extensions of the respective services documented for <type>ConfigurationAccess</type>. 65*b1cdbd2cSJim Jagielski </p> 66*b1cdbd2cSJim Jagielski <ul> 67*b1cdbd2cSJim Jagielski <li><em>Container</em> role: 68*b1cdbd2cSJim Jagielski A <em>group</em> permits changing child values. 69*b1cdbd2cSJim Jagielski A <em>set</em> permits inserting and removing contained elements. 70*b1cdbd2cSJim Jagielski </li> 71*b1cdbd2cSJim Jagielski <li><em>Element</em> role: 72*b1cdbd2cSJim Jagielski The root element of a modifiable tree provides extended functionality 73*b1cdbd2cSJim Jagielski to control processing of changes for the entire tree (fragment) by 74*b1cdbd2cSJim Jagielski supporting <type scope="com::sun::star::util">XChangesBatch</type>. 75*b1cdbd2cSJim Jagielski For elements of a <em>set</em> or a <em>group</em> no additinal 76*b1cdbd2cSJim Jagielski interfaces are supported. 77*b1cdbd2cSJim Jagielski </li> 78*b1cdbd2cSJim Jagielski </ul> 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski @see ConfigurationProvider 81*b1cdbd2cSJim Jagielski Root instances of this service can be requested from a 82*b1cdbd2cSJim Jagielski <type>ConfigurationProvider</type> 83*b1cdbd2cSJim Jagielski*/ 84*b1cdbd2cSJim Jagielskipublished service ConfigurationUpdateAccess 85*b1cdbd2cSJim Jagielski{ 86*b1cdbd2cSJim Jagielski /** is the basic service providing read access to an element of the 87*b1cdbd2cSJim Jagielski configuration hierarchy and its child and descendent elements. 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski <p>The <type>HierarchyAccess</type> specialization implemented will be 90*b1cdbd2cSJim Jagielski further specialized to support modifying access. 91*b1cdbd2cSJim Jagielski Implementations shall therefore implement one of <type>SetUpdate</type> or 92*b1cdbd2cSJim Jagielski <type>GroupUpdate</type> depending on the <em>Container</em> role. 93*b1cdbd2cSJim Jagielski </p> 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski <p>If the <type>HierarchyElement</type> specialization that is implemented 96*b1cdbd2cSJim Jagielski is <type>AccessRootElement</type>, the implementation must support the 97*b1cdbd2cSJim Jagielski extended functionality of <type>UpdateRootElement</type>. Otherwise, there 98*b1cdbd2cSJim Jagielski are no new requirements mandated by the <em>Element</em> role. 99*b1cdbd2cSJim Jagielski </p> 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski */ 102*b1cdbd2cSJim Jagielski service ConfigurationAccess; 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski /** specializes <type>SetAccess</type> to support modifying the element. 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski <p>Implemented, if this element is a <em>Set</em>. 107*b1cdbd2cSJim Jagielski Otherwise service <type>GroupUpdate</type> is provided. 108*b1cdbd2cSJim Jagielski </p> 109*b1cdbd2cSJim Jagielski */ 110*b1cdbd2cSJim Jagielski [optional] service SetUpdate; 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski /** specializes <type>GroupAccess</type> to support modifying contained 113*b1cdbd2cSJim Jagielski data. 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski <p>Implemented, if this element is a <em>Group</em>. 116*b1cdbd2cSJim Jagielski Otherwise service <type>SetUpdate</type> is provided. 117*b1cdbd2cSJim Jagielski </p> 118*b1cdbd2cSJim Jagielski */ 119*b1cdbd2cSJim Jagielski [optional] service GroupUpdate; 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski /** specializes <type>AccessRootElement</type> to support transaction-like 122*b1cdbd2cSJim Jagielski control over a batch of changes accumulated within the tree fragment. 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski <p>Implemented, if this element is the <em>Root</em> of the whole hierarchy. 125*b1cdbd2cSJim Jagielski Otherwise either <type>SetElement</type> or <type>GroupElement</type> is provided. 126*b1cdbd2cSJim Jagielski </p> 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski @see ConfigurationProvider 129*b1cdbd2cSJim Jagielski Instances obtained from a <type>ConfigurationProvider</type> will 130*b1cdbd2cSJim Jagielski implement this version of <type>HierarchyElement</type>. 131*b1cdbd2cSJim Jagielski */ 132*b1cdbd2cSJim Jagielski [optional] service UpdateRootElement; 133*b1cdbd2cSJim Jagielski}; 134*b1cdbd2cSJim Jagielski 135*b1cdbd2cSJim Jagielski//============================================================================= 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski}; }; }; }; 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski#endif 140*b1cdbd2cSJim Jagielski 141