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