1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_configuration_ConfigurationUpdateAccess_idl__ 24cdf0e10cSrcweir#define __com_sun_star_configuration_ConfigurationUpdateAccess_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_configuration_ConfigurationAccess_idl__ 27cdf0e10cSrcweir#include <com/sun/star/configuration/ConfigurationAccess.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_configuration_SetUpdate_idl__ 31cdf0e10cSrcweir#include <com/sun/star/configuration/SetUpdate.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_configuration_GroupUpdate_idl__ 35cdf0e10cSrcweir#include <com/sun/star/configuration/GroupUpdate.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_configuration_UpdateRootElement_idl__ 39cdf0e10cSrcweir#include <com/sun/star/configuration/UpdateRootElement.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir//============================================================================= 43cdf0e10cSrcweir 44cdf0e10cSrcweirmodule com { module sun { module star { module configuration { 45cdf0e10cSrcweir 46cdf0e10cSrcweir//============================================================================= 47cdf0e10cSrcweir/** provides modifying access to a fragment of the configuration hierarchy. 48cdf0e10cSrcweir 49cdf0e10cSrcweir <p>Extends <type>ConfigurationAccess</type> to support modifying values 50cdf0e10cSrcweir or inserting and removing elements. 51cdf0e10cSrcweir </p> 52cdf0e10cSrcweir 53cdf0e10cSrcweir <p>Descendants of this service also implement this service 54cdf0e10cSrcweir unless they are marked <em>read-only</em> (which is indicated by attribute 55cdf0e10cSrcweir <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>), 56cdf0e10cSrcweir in which case they only need implement <type>ConfigurationAccess</type>. 57cdf0e10cSrcweir </p> 58cdf0e10cSrcweir 59cdf0e10cSrcweir <p>The classification of implementations that is described for 60cdf0e10cSrcweir <type>ConfigurationAccess</type> applies to implementations of this service 61cdf0e10cSrcweir as well. Therefore an implementation will support one of several alternate 62cdf0e10cSrcweir services describing its <em>Container</em> role and one of several alternate 63cdf0e10cSrcweir services describing its <em>Element</em> role. These services are 64cdf0e10cSrcweir extensions of the respective services documented for <type>ConfigurationAccess</type>. 65cdf0e10cSrcweir </p> 66cdf0e10cSrcweir <ul> 67cdf0e10cSrcweir <li><em>Container</em> role: 68cdf0e10cSrcweir A <em>group</em> permits changing child values. 69cdf0e10cSrcweir A <em>set</em> permits inserting and removing contained elements. 70cdf0e10cSrcweir </li> 71cdf0e10cSrcweir <li><em>Element</em> role: 72cdf0e10cSrcweir The root element of a modifiable tree provides extended functionality 73cdf0e10cSrcweir to control processing of changes for the entire tree (fragment) by 74cdf0e10cSrcweir supporting <type scope="com::sun::star::util">XChangesBatch</type>. 75cdf0e10cSrcweir For elements of a <em>set</em> or a <em>group</em> no additinal 76cdf0e10cSrcweir interfaces are supported. 77cdf0e10cSrcweir </li> 78cdf0e10cSrcweir </ul> 79cdf0e10cSrcweir 80cdf0e10cSrcweir @see ConfigurationProvider 81cdf0e10cSrcweir Root instances of this service can be requested from a 82cdf0e10cSrcweir <type>ConfigurationProvider</type> 83cdf0e10cSrcweir*/ 84cdf0e10cSrcweirpublished service ConfigurationUpdateAccess 85cdf0e10cSrcweir{ 86cdf0e10cSrcweir /** is the basic service providing read access to an element of the 87cdf0e10cSrcweir configuration hierarchy and its child and descendent elements. 88cdf0e10cSrcweir 89cdf0e10cSrcweir <p>The <type>HierarchyAccess</type> specialization implemented will be 90cdf0e10cSrcweir further specialized to support modifying access. 91cdf0e10cSrcweir Implementations shall therefore implement one of <type>SetUpdate</type> or 92cdf0e10cSrcweir <type>GroupUpdate</type> depending on the <em>Container</em> role. 93cdf0e10cSrcweir </p> 94cdf0e10cSrcweir 95cdf0e10cSrcweir <p>If the <type>HierarchyElement</type> specialization that is implemented 96cdf0e10cSrcweir is <type>AccessRootElement</type>, the implementation must support the 97cdf0e10cSrcweir extended functionality of <type>UpdateRootElement</type>. Otherwise, there 98cdf0e10cSrcweir are no new requirements mandated by the <em>Element</em> role. 99cdf0e10cSrcweir </p> 100cdf0e10cSrcweir 101cdf0e10cSrcweir */ 102cdf0e10cSrcweir service ConfigurationAccess; 103cdf0e10cSrcweir 104cdf0e10cSrcweir /** specializes <type>SetAccess</type> to support modifying the element. 105cdf0e10cSrcweir 106cdf0e10cSrcweir <p>Implemented, if this element is a <em>Set</em>. 107cdf0e10cSrcweir Otherwise service <type>GroupUpdate</type> is provided. 108cdf0e10cSrcweir </p> 109cdf0e10cSrcweir */ 110cdf0e10cSrcweir [optional] service SetUpdate; 111cdf0e10cSrcweir 112cdf0e10cSrcweir /** specializes <type>GroupAccess</type> to support modifying contained 113cdf0e10cSrcweir data. 114cdf0e10cSrcweir 115cdf0e10cSrcweir <p>Implemented, if this element is a <em>Group</em>. 116cdf0e10cSrcweir Otherwise service <type>SetUpdate</type> is provided. 117cdf0e10cSrcweir </p> 118cdf0e10cSrcweir */ 119cdf0e10cSrcweir [optional] service GroupUpdate; 120cdf0e10cSrcweir 121cdf0e10cSrcweir /** specializes <type>AccessRootElement</type> to support transaction-like 122cdf0e10cSrcweir control over a batch of changes accumulated within the tree fragment. 123cdf0e10cSrcweir 124cdf0e10cSrcweir <p>Implemented, if this element is the <em>Root</em> of the whole hierarchy. 125cdf0e10cSrcweir Otherwise either <type>SetElement</type> or <type>GroupElement</type> is provided. 126cdf0e10cSrcweir </p> 127cdf0e10cSrcweir 128cdf0e10cSrcweir @see ConfigurationProvider 129cdf0e10cSrcweir Instances obtained from a <type>ConfigurationProvider</type> will 130cdf0e10cSrcweir implement this version of <type>HierarchyElement</type>. 131cdf0e10cSrcweir */ 132cdf0e10cSrcweir [optional] service UpdateRootElement; 133cdf0e10cSrcweir}; 134cdf0e10cSrcweir 135cdf0e10cSrcweir//============================================================================= 136cdf0e10cSrcweir 137cdf0e10cSrcweir}; }; }; }; 138cdf0e10cSrcweir 139cdf0e10cSrcweir#endif 140cdf0e10cSrcweir 141