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_UpdateRootElement_idl__
24#define __com_sun_star_configuration_UpdateRootElement_idl__
25
26#ifndef __com_sun_star_configuration_AccessRootElement_idl__
27#include <com/sun/star/configuration/AccessRootElement.idl>
28#endif
29
30#ifndef __com_sun_star_util_XChangesBatch_idl__
31#include <com/sun/star/util/XChangesBatch.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module configuration {
37
38//=============================================================================
39/** provides update control for a hierarchy of configuration items
40 and information about the hierarchy as a whole as well as its root.
41
42 <p>Extends <type>AccessRootElement</type> by adding support for
43 collecting changes and applying them to a backend store as a single batch.
44 </p>
45
46 <p>An implementation represents the root of a partial hierarchy. [See the
47 documentation for <type>AccessRootElement</type>]. The hierarchy in turn is
48 a <em>view</em> onto a fragment of persistent data tree that can be accessed
49 through several such views, or even several processes, simultaneously.
50 </p>
51
52 <p>Elements of the hierarchy, such as descendants of this root element,
53 may support modification by providing appropriate
54 interfaces. Changes done this way initially only affect these objects
55 themselves and other objects within the same hierarchy, such as other
56 descendants of this root element.
57 </p>
58
59 <p>The accumulated changes within this hierarchy can be managed using
60 <type scope="com::sun::star::util">XChangesBatch</type>. Pending changes
61 will become persistent and visible from other overlapping hierarchies
62 only when <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member>
63 is called. If the hierarchy is disposed or discarded without committing
64 changes, the changes will be lost.
65 </p>
66
67 @see com::sun::star::configuration::GroupUpdate
68 @see com::sun::star::configuration::SetUpdate
69*/
70published service UpdateRootElement
71{
72/** provides (read-only) access to information about the root element of
73 (a fragment of) the hierarchy. It also provides some functionality concerning
74 the hierarchy (fragment) accessible from that element as a whole.
75*/
76	service AccessRootElement;
77
78/** allows managing changes within the hierarchy.
79
80 <p><member scope="com::sun::star::util">XChangesBatch::getPendingChanges()</member>
81 reports all changes within the hierarchy that are done through (direct or
82 indirect) descendants of this element. The same set of changes is committed
83 to persistent storage and/or made visible to other objects accessing the same
84 data set, when
85 <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member>
86 is invoked.
87 </p>
88
89 <p>If the implementation supports
90 <member scope="com::sun::star::lang">XLocalizable::setLocale()</member>, changes
91 will be considered to apply to the locale that is set when
92 <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member>
93 is invoked.
94 </p>
95
96 @ see AccessRootElement
97 @ see com::sun::star::util::XChangesNotifier
98*/
99	interface com::sun::star::util::XChangesBatch;
100};
101
102//=============================================================================
103
104}; }; }; };
105
106#endif
107