offapi/com/sun/star/configuration/SetUpdate.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: SetUpdate.idl,v $
  10  * $Revision: 1.7 $
  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_SetUpdate_idl__
  31 #define __com_sun_star_configuration_SetUpdate_idl__
  32
  33 #ifndef __com_sun_star_configuration_SetAccess_idl__
  34 #include <com/sun/star/configuration/SetAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_configuration_SimpleSetUpdate_idl__
  38 #include <com/sun/star/configuration/SimpleSetUpdate.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module configuration {
  44
  45 //=============================================================================
  46 /** provides write access to a dynamic homogeneous set of values or nested
  47  trees within a hierarchy.
  48
  49  <p>Allows adding and removing elements.
  50  Helps creates new elements to be added.
  51  </p>
  52
  53  <p>This service extends <type>SetAccess</type> to support
  54  modifying the container.
  55  </p>
  56
  57  <p>Any child and descendant objects support modifying access as well,
  58  unless they represent a read-only tree element (as indicated by
  59  <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>).
  60  </p>
  61 */
  62 published service SetUpdate
  63 {
  64 /** is the basic service providing read access to a <em>set</em> within the
  65  hierarchy.
  66 */
  67     service SetAccess;
  68
  69 /** is the basic service providing modifying access to a
  70  not necessarily hierarchical <em>set</em>.
  71
  72  <p>Changes can be observed by registering a listener with interface
  73  <type scope="com::sun::star::container">XContainer</type>.
  74  </p>
  75
  76  <p>If the elements of this set are of object type, new elements are constructed
  77  to match the tree structure prescribed by the element template of this set, when
  78  using interfaces <type scope="com::sun::star::lang">XSingleServiceFactory</type>
  79  and (if supported) <type scope="com::sun::star::lang">XMultiServiceFactory</type>.
  80  </p>
  81
  82  <p>Objects that are removed from a set can be reinserted into any set supporting
  83  the same template within the same hierarchy. Even under a different name.
  84  </p>
  85
  86  <p>Implementations that support insertion of objects that weren't obtained
  87  from within the hierarchy must reject elements that don't have the correct
  88  structure as described by the template, even if the object returns the
  89  correct template name from <member>XTemplateInstance::getTemplateName()</member>.
  90  </p>
  91
  92  <p>Other ways in which an element may be moved among or within compatible sets
  93  include <member scope="com::sun::star::container">XChild::setParent()</member>
  94  and <member scope="com::sun::star::container">XNamed::setName()</member>, if
  95  the element implements them.
  96  </p>
  97
  98  @see com::sun::star::configuration::SetElement
  99 */
 100     service SimpleSetUpdate;
 101
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; };
 107
 108 #endif