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_SimpleSetAccess_idl__
24#define __com_sun_star_configuration_SimpleSetAccess_idl__
25
26#ifndef __com_sun_star_container_XNameAccess_idl__
27#include <com/sun/star/container/XNameAccess.idl>
28#endif
29
30#ifndef __com_sun_star_configuration_XTemplateContainer_idl__
31#include <com/sun/star/configuration/XTemplateContainer.idl>
32#endif
33
34#ifndef __com_sun_star_util_XStringEscape_idl__
35#include <com/sun/star/util/XStringEscape.idl>
36#endif
37
38#ifndef __com_sun_star_container_XContainer_idl__
39#include <com/sun/star/container/XContainer.idl>
40#endif
41
42//=============================================================================
43
44module com { module sun { module star { module configuration {
45
46//=============================================================================
47/** provides access to a dynamic, homogeneous, nonhierarchical set of values
48 or objects.
49
50 <p>Also provides information about the template for elements.
51 Allows normalizing externally generated names.
52 </p>
53
54 <p><em>Sets</em> are dynamic containers.</p>
55
56 <p>The number and names of contained elements is not fixed in advance,
57 but all elements have to be of one predetermined type.
58 </p>
59*/
60published service SimpleSetAccess
61{
62/** is the basic service for accessing child and descendent nodes.
63
64 <p>External names from foreign namespaces should be normalized using
65 <member scope="com::sun::star::util">XStringEscape::escapeString()</member>,
66 if available, before using them as element names.
67 </p>
68*/
69	interface com::sun::star::container::XNameAccess;
70
71/** provides additional information about the element type. [optional]
72
73 <p>All set elements, if they are not just simple values, but whole trees,
74 must have a predetermined structure (their <em>type</em>)
75 that is described by and can be generated from a <em>template</em>.
76 The semantics of the information provided about the template depends on the
77 implementation.
78 </p>
79
80 <p>This interface may be missing, if the implementation can support only
81 one predefined type or if the elements are of a simple type and
82 no further information is available.  In the latter case,
83 <member scope="com::sun::star::container">XElementAccess::getElementType()</member>
84 provides all the information there is about the element's type.
85 </p>
86*/
87	[optional] interface com::sun::star::configuration::XTemplateContainer;
88
89/** allows normalizing and denormalizing external names. [optional]
90
91 <p>Elements of a <em>set</em> often correspond to external entities,
92 for example, files, web pages, and people whose names obey different rules and
93 restrictions than names that are valid in the hierarchical naming scheme.
94 </p>
95
96 <p>This interface may be missing if there are no naming restrictions,
97 if the implementation handles any such conversions internally,
98 or if clients must enforce such restrictions themselves. In the last case,
99 the naming scheme documentation must fully document any restrictions.
100 </p>
101*/
102	[optional] interface com::sun::star::util::XStringEscape;
103
104/** allows attaching listeners to this node to monitor changes to the set. [optional]
105
106 <p>This interface may be missing if the implementation does not support
107 notifications.
108 </p>
109*/
110	[optional] interface com::sun::star::container::XContainer;
111
112};
113
114//=============================================================================
115
116}; }; }; };
117
118#endif
119