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