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