1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_configuration_SetUpdate_idl__
24#define __com_sun_star_configuration_SetUpdate_idl__
25
26#ifndef __com_sun_star_configuration_SetAccess_idl__
27#include <com/sun/star/configuration/SetAccess.idl>
28#endif
29
30#ifndef __com_sun_star_configuration_SimpleSetUpdate_idl__
31#include <com/sun/star/configuration/SimpleSetUpdate.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module configuration {
37
38//=============================================================================
39/** provides write access to a dynamic homogeneous set of values or nested
40 trees within a hierarchy.
41
42 <p>Allows adding and removing elements.
43 Helps creates new elements to be added.
44 </p>
45
46 <p>This service extends <type>SetAccess</type> to support
47 modifying the container.
48 </p>
49
50 <p>Any child and descendant objects support modifying access as well,
51 unless they represent a read-only tree element (as indicated by
52 <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>).
53 </p>
54*/
55published service SetUpdate
56{
57/** is the basic service providing read access to a <em>set</em> within the
58 hierarchy.
59*/
60	service SetAccess;
61
62/** is the basic service providing modifying access to a
63 not necessarily hierarchical <em>set</em>.
64
65 <p>Changes can be observed by registering a listener with interface
66 <type scope="com::sun::star::container">XContainer</type>.
67 </p>
68
69 <p>If the elements of this set are of object type, new elements are constructed
70 to match the tree structure prescribed by the element template of this set, when
71 using interfaces <type scope="com::sun::star::lang">XSingleServiceFactory</type>
72 and (if supported) <type scope="com::sun::star::lang">XMultiServiceFactory</type>.
73 </p>
74
75 <p>Objects that are removed from a set can be reinserted into any set supporting
76 the same template within the same hierarchy. Even under a different name.
77 </p>
78
79 <p>Implementations that support insertion of objects that weren't obtained
80 from within the hierarchy must reject elements that don't have the correct
81 structure as described by the template, even if the object returns the
82 correct template name from <member>XTemplateInstance::getTemplateName()</member>.
83 </p>
84
85 <p>Other ways in which an element may be moved among or within compatible sets
86 include <member scope="com::sun::star::container">XChild::setParent()</member>
87 and <member scope="com::sun::star::container">XNamed::setName()</member>, if
88 the element implements them.
89 </p>
90
91 @see com::sun::star::configuration::SetElement
92*/
93	service SimpleSetUpdate;
94
95};
96
97//=============================================================================
98
99}; }; }; };
100
101#endif
102