1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_configuration_UpdateRootElement_idl__
28#define __com_sun_star_configuration_UpdateRootElement_idl__
29
30#ifndef __com_sun_star_configuration_AccessRootElement_idl__
31#include <com/sun/star/configuration/AccessRootElement.idl>
32#endif
33
34#ifndef __com_sun_star_util_XChangesBatch_idl__
35#include <com/sun/star/util/XChangesBatch.idl>
36#endif
37
38//=============================================================================
39
40module com { module sun { module star { module configuration {
41
42//=============================================================================
43/** provides update control for a hierarchy of configuration items
44 and information about the hierarchy as a whole as well as its root.
45
46 <p>Extends <type>AccessRootElement</type> by adding support for
47 collecting changes and applying them to a backend store as a single batch.
48 </p>
49
50 <p>An implementation represents the root of a partial hierarchy. [See the
51 documentation for <type>AccessRootElement</type>]. The hierarchy in turn is
52 a <em>view</em> onto a fragment of persistent data tree that can be accessed
53 through several such views, or even several processes, simultaneously.
54 </p>
55
56 <p>Elements of the hierarchy, such as descendants of this root element,
57 may support modification by providing appropriate
58 interfaces. Changes done this way initially only affect these objects
59 themselves and other objects within the same hierarchy, such as other
60 descendants of this root element.
61 </p>
62
63 <p>The accumulated changes within this hierarchy can be managed using
64 <type scope="com::sun::star::util">XChangesBatch</type>. Pending changes
65 will become persistent and visible from other overlapping hierarchies
66 only when <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member>
67 is called. If the hierarchy is disposed or discarded without committing
68 changes, the changes will be lost.
69 </p>
70
71 @see com::sun::star::configuration::GroupUpdate
72 @see com::sun::star::configuration::SetUpdate
73*/
74published service UpdateRootElement
75{
76/** provides (read-only) access to information about the root element of
77 (a fragment of) the hierarchy. It also provides some functionality concerning
78 the hierarchy (fragment) accessible from that element as a whole.
79*/
80	service AccessRootElement;
81
82/** allows managing changes within the hierarchy.
83
84 <p><member scope="com::sun::star::util">XChangesBatch::getPendingChanges()</member>
85 reports all changes within the hierarchy that are done through (direct or
86 indirect) descendants of this element. The same set of changes is committed
87 to persistent storage and/or made visible to other objects accessing the same
88 data set, when
89 <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member>
90 is invoked.
91 </p>
92
93 <p>If the implementation supports
94 <member scope="com::sun::star::lang">XLocalizable::setLocale()</member>, changes
95 will be considered to apply to the locale that is set when
96 <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member>
97 is invoked.
98 </p>
99
100 @ see AccessRootElement
101 @ see com::sun::star::util::XChangesNotifier
102*/
103	interface com::sun::star::util::XChangesBatch;
104};
105
106//=============================================================================
107
108}; }; }; };
109
110#endif
111