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

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