offapi/com/sun/star/configuration/ConfigurationUpdateAccess.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: ConfigurationUpdateAccess.idl,v $
  10  * $Revision: 1.14 $
  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_ConfigurationUpdateAccess_idl__
  31 #define __com_sun_star_configuration_ConfigurationUpdateAccess_idl__
  32
  33 #ifndef __com_sun_star_configuration_ConfigurationAccess_idl__
  34 #include <com/sun/star/configuration/ConfigurationAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_configuration_SetUpdate_idl__
  38 #include <com/sun/star/configuration/SetUpdate.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_configuration_GroupUpdate_idl__
  42 #include <com/sun/star/configuration/GroupUpdate.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_configuration_UpdateRootElement_idl__
  46 #include <com/sun/star/configuration/UpdateRootElement.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com { module sun { module star { module configuration {
  52
  53 //=============================================================================
  54 /** provides modifying access to a fragment of the configuration hierarchy.
  55
  56  <p>Extends <type>ConfigurationAccess</type> to support modifying values
  57  or inserting and removing elements.
  58  </p>
  59
  60  <p>Descendants of this service also implement this service
  61  unless they are marked <em>read-only</em> (which is indicated by attribute
  62  <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>),
  63  in which case they only need implement <type>ConfigurationAccess</type>.
  64  </p>
  65
  66  <p>The classification of implementations that is described for
  67  <type>ConfigurationAccess</type> applies to implementations of this service
  68  as well. Therefore an implementation will support one of several alternate
  69  services describing its <em>Container</em> role and one of several alternate
  70  services describing its <em>Element</em> role. These services are
  71  extensions of the respective services documented for <type>ConfigurationAccess</type>.
  72  </p>
  73  <ul>
  74     <li><em>Container</em> role:
  75         A <em>group</em> permits changing child values.
  76         A <em>set</em> permits inserting and removing contained elements.
  77     </li>
  78     <li><em>Element</em> role:
  79         The root element of a modifiable tree provides extended functionality
  80         to control processing of changes for the entire tree (fragment) by
  81         supporting <type scope="com::sun::star::util">XChangesBatch</type>.
  82         For elements of a <em>set</em> or a <em>group</em> no additinal
  83         interfaces are supported.
  84     </li>
  85  </ul>
  86
  87  @see ConfigurationProvider
  88     Root instances of this service can be requested from a
  89     <type>ConfigurationProvider</type>
  90 */
  91 published service ConfigurationUpdateAccess
  92 {
  93     /** is the basic service providing read access to an element of the
  94      configuration hierarchy and its child and descendent elements.
  95
  96      <p>The <type>HierarchyAccess</type> specialization implemented will be
  97      further specialized to support modifying access.
  98      Implementations shall therefore implement one of <type>SetUpdate</type> or
  99      <type>GroupUpdate</type> depending on the <em>Container</em> role.
 100      </p>
 101
 102      <p>If the <type>HierarchyElement</type> specialization that is implemented
 103      is <type>AccessRootElement</type>, the implementation must support the
 104      extended functionality of <type>UpdateRootElement</type>. Otherwise, there
 105      are no new requirements mandated by the <em>Element</em> role.
 106      </p>
 107
 108     */
 109     service ConfigurationAccess;
 110
 111     /** specializes <type>SetAccess</type> to support modifying the element.
 112
 113      <p>Implemented, if this element is a <em>Set</em>.
 114      Otherwise service <type>GroupUpdate</type> is provided.
 115      </p>
 116     */
 117     [optional] service SetUpdate;
 118
 119     /** specializes <type>GroupAccess</type> to support modifying contained
 120      data.
 121
 122      <p>Implemented, if this element is a <em>Group</em>.
 123      Otherwise service <type>SetUpdate</type> is provided.
 124      </p>
 125     */
 126     [optional] service GroupUpdate;
 127
 128     /** specializes <type>AccessRootElement</type> to support transaction-like
 129      control over a batch of changes accumulated within the tree fragment.
 130
 131      <p>Implemented, if this element is the <em>Root</em> of the whole hierarchy.
 132      Otherwise either <type>SetElement</type> or <type>GroupElement</type> is provided.
 133      </p>
 134
 135      @see ConfigurationProvider
 136         Instances obtained from a <type>ConfigurationProvider</type> will
 137         implement this version of <type>HierarchyElement</type>.
 138     */
 139     [optional] service UpdateRootElement;
 140 };
 141
 142 //=============================================================================
 143
 144 }; }; }; };
 145
 146 #endif
 147