1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_configuration_ConfigurationRegistry_idl__
24#define __com_sun_star_configuration_ConfigurationRegistry_idl__
25
26//=============================================================================
27
28#ifndef __com_sun_star_registry_XSimpleRegistry_idl__
29#include <com/sun/star/registry/XSimpleRegistry.idl>
30#endif
31#ifndef __com_sun_star_util_XFlushable_idl__
32#include <com/sun/star/util/XFlushable.idl>
33#endif
34
35module com { module sun { module star { module configuration {
36
37//=============================================================================
38
39
40/*	provides access to a configuration tree as a registry.
41
42    <p>This service is deprecated,
43    <type scope="com.sun.star.configuration">ConfigurationProvider</type> should
44    be used instead.</p>
45
46	<p> Using the <type scope="com::sun::star::registry">XSimpleRegistry</type>
47	interface, the service can be bound to a subtree within the
48	configuration tree, as provided by an
49	<type scope="com.sun.star.configuration">ConfigurationProvider</type>
50	service, which must be accessible from the service factory you use for the
51	creation of this service.
52	</p>
53	<p>	There are some restrictions when accessing a configuration tree using a registry.
54	Most of them are implications of the fact that a configuration tree is very static in
55	it's structure. Removal and addition of sub nodes is allowed only for special
56	nodes, and even then the new elements have to comply to a given scheme (which is some
57	kind of attribute of the container node). So for instance the
58	<member scope="com.sun.star.registry">XRegistryKey::createKey()</member> method is not allowed
59	for some nodes.
60	</p><p>
61	Thus anybody using this service is strongly advised to read and understand the specification
62	of an configuration provider (<type scope="com.sun.star.configuration">ConfigurationProvider</type>)
63	and all of it's aspects.
64	</p>
65
66	@author	Frank Schoenheit
67	@version 1.0 2000/07/06
68*/
69
70published service ConfigurationRegistry
71{
72	/** controls the binding of the object to a configuration sub tree.
73		<p><member scope="com::sun::star::registry">XSimpleRegistry::open()</member>
74		is used to open a special subtree within the configuration tree.
75		</p>
76		<p>The parameters of this method control the location of the root of the to-be-opened
77		configuration node and the access mode (read only or updatable).
78		</p>
79	*/
80	interface com::sun::star::registry::XSimpleRegistry;
81
82	/** is used to commit changes to the configuration.
83		<p>As specified for the
84		<type scope="com::sun::star::configuration">ConfigurationUpdateAccess</type>
85		service, all changes made to an configuration subtree have to be committed
86		before they become persistent.
87		To do this for a configuration accessed as a registry, call
88		<method scope="com::sun::star::util">XFlushable::flush</method>.
89		</p>
90		<p><strong>Warning:</strong><em>Changes that are not flushed will be
91		lost.</em>
92		</p>
93	*/
94	interface com::sun::star::util::XFlushable;
95};
96
97
98//=============================================================================
99
100}; }; }; };
101
102
103#endif
104
105