offapi/com/sun/star/configuration/UpdateRootElement.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_configuration_UpdateRootElement_idl__
  20 #define __com_sun_star_configuration_UpdateRootElement_idl__
  21
  22 #include <com/sun/star/configuration/AccessRootElement.idl>
  23 #include <com/sun/star/util/XChangesBatch.idl>
  24
  25
  26 module com { module sun { module star { module configuration {
  27
  28 /** provides update control for a hierarchy of configuration items
  29  and information about the hierarchy as a whole as well as its root.
  30
  31  <p>Extends <type>AccessRootElement</type> by adding support for
  32  collecting changes and applying them to a backend store as a single batch.
  33  </p>
  34
  35  <p>An implementation represents the root of a partial hierarchy. [See the
  36  documentation for <type>AccessRootElement</type>]. The hierarchy in turn is
  37  a <em>view</em> onto a fragment of persistent data tree that can be accessed
  38  through several such views, or even several processes, simultaneously.
  39  </p>
  40
  41  <p>Elements of the hierarchy, such as descendants of this root element,
  42  may support modification by providing appropriate
  43  interfaces. Changes done this way initially only affect these objects
  44  themselves and other objects within the same hierarchy, such as other
  45  descendants of this root element.
  46  </p>
  47
  48  <p>The accumulated changes within this hierarchy can be managed using
  49  <type scope="com::sun::star::util">XChangesBatch</type>. Pending changes
  50  will become persistent and visible from other overlapping hierarchies
  51  only when <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member>
  52  is called. If the hierarchy is disposed or discarded without committing
  53  changes, the changes will be lost.
  54  </p>
  55
  56  @see com::sun::star::configuration::GroupUpdate
  57  @see com::sun::star::configuration::SetUpdate
  58 */
  59 published service UpdateRootElement
  60 {
  61 /** provides (read-only) access to information about the root element of
  62  (a fragment of) the hierarchy. It also provides some functionality concerning
  63  the hierarchy (fragment) accessible from that element as a whole.
  64 */
  65     service AccessRootElement;
  66
  67 /** allows managing changes within the hierarchy.
  68
  69  <p><member scope="com::sun::star::util">XChangesBatch::getPendingChanges()</member>
  70  reports all changes within the hierarchy that are done through (direct or
  71  indirect) descendants of this element. The same set of changes is committed
  72  to persistent storage and/or made visible to other objects accessing the same
  73  data set, when
  74  <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member>
  75  is invoked.
  76  </p>
  77
  78  <p>If the implementation supports
  79  <member scope="com::sun::star::lang">XLocalizable::setLocale()</member>, changes
  80  will be considered to apply to the locale that is set when
  81  <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member>
  82  is invoked.
  83  </p>
  84
  85  @ see AccessRootElement
  86  @ see com::sun::star::util::XChangesNotifier
  87 */
  88     interface com::sun::star::util::XChangesBatch;
  89 };
  90
  91
  92 }; }; }; };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */