xref: /aoo42x/main/offapi/com/sun/star/sdbcx/Container.idl (revision d1766043)
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_sdbcx_Container_idl__
24#define __com_sun_star_sdbcx_Container_idl__
25
26 module com {  module sun {  module star {  module container {
27 published interface XNameAccess;
28 published interface XIndexAccess;
29 published interface XEnumerationAccess;
30};};};};
31
32 module com {  module sun {  module star {  module util {
33 published interface XRefreshable;
34};};};};
35
36 module com {  module sun {  module star {  module sdbcx {
37
38 published interface XDataDescriptorFactory;
39 published interface XAppend;
40 published interface XDrop;
41
42
43/** describes every container which is used for data definition. Each
44	container must support access to its elements by the element's name or
45	by the element's position.
46
47	<p>
48	Simple enumeration must be supported as well.
49	</p>
50	<p>
51	To reflect the changes with the underlying database, a refresh mechanism
52	needs to be supported.
53	</p>
54	<p>
55	A container may support the possibility to add new elements or to drop
56	existing elements. Additions are always done by descriptors which define the
57	properties of the new element.
58	</p>
59 */
60published service Container
61{
62	// gives access to the elements by name.
63	interface com::sun::star::container::XNameAccess;
64
65	// gives access to the elements by index.
66	interface com::sun::star::container::XIndexAccess;
67
68	// used to create an enumeration of the elements.
69	interface com::sun::star::container::XEnumerationAccess;
70
71
72	/** is optional for implementation. Used to reflect changes.
73	 */
74	[optional] interface com::sun::star::util::XRefreshable;
75
76	/** optional for implementation. Allows to create descriptor elements which then could be used to append new elements.
77	 */
78	[optional] interface XDataDescriptorFactory;
79
80	/** optional for implementation, provides the possibility of adding
81				a new element to the container.
82	 */
83	[optional] interface XAppend;
84
85	/** optional for implementation, provides the possibility of dropping
86				an element from the container.
87	 */
88	[optional] interface XDrop;
89};
90
91//=============================================================================
92
93}; }; }; };
94
95/*===========================================================================
96===========================================================================*/
97#endif
98