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

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