xref: /aoo41x/main/offapi/com/sun/star/sdbcx/Container.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_sdbcx_Container_idl__
24cdf0e10cSrcweir#define __com_sun_star_sdbcx_Container_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir module com {  module sun {  module star {  module container {
27cdf0e10cSrcweir published interface XNameAccess;
28cdf0e10cSrcweir published interface XIndexAccess;
29cdf0e10cSrcweir published interface XEnumerationAccess;
30cdf0e10cSrcweir};};};};
31cdf0e10cSrcweir
32cdf0e10cSrcweir module com {  module sun {  module star {  module util {
33cdf0e10cSrcweir published interface XRefreshable;
34cdf0e10cSrcweir};};};};
35cdf0e10cSrcweir
36cdf0e10cSrcweir module com {  module sun {  module star {  module sdbcx {
37cdf0e10cSrcweir
38cdf0e10cSrcweir published interface XDataDescriptorFactory;
39cdf0e10cSrcweir published interface XAppend;
40cdf0e10cSrcweir published interface XDrop;
41cdf0e10cSrcweir
42cdf0e10cSrcweir
43cdf0e10cSrcweir/** describes every container which is used for data definition. Each
44cdf0e10cSrcweir	container must support access to its elements by the element's name or
45cdf0e10cSrcweir	by the element's position.
46cdf0e10cSrcweir
47cdf0e10cSrcweir	<p>
48cdf0e10cSrcweir	Simple enumeration must be supported as well.
49cdf0e10cSrcweir	</p>
50cdf0e10cSrcweir	<p>
51cdf0e10cSrcweir	To reflect the changes with the underlying database, a refresh mechanism
52cdf0e10cSrcweir	needs to be supported.
53cdf0e10cSrcweir	</p>
54cdf0e10cSrcweir	<p>
55cdf0e10cSrcweir	A container may support the possibility to add new elements or to drop
56cdf0e10cSrcweir	existing elements. Additions are always done by descriptors which define the
57cdf0e10cSrcweir	properties of the new element.
58cdf0e10cSrcweir	</p>
59cdf0e10cSrcweir */
60cdf0e10cSrcweirpublished service Container
61cdf0e10cSrcweir{
62cdf0e10cSrcweir	// gives access to the elements by name.
63cdf0e10cSrcweir	interface com::sun::star::container::XNameAccess;
64cdf0e10cSrcweir
65cdf0e10cSrcweir	// gives access to the elements by index.
66cdf0e10cSrcweir	interface com::sun::star::container::XIndexAccess;
67cdf0e10cSrcweir
68cdf0e10cSrcweir	// used to create an enumeration of the elements.
69cdf0e10cSrcweir	interface com::sun::star::container::XEnumerationAccess;
70cdf0e10cSrcweir
71cdf0e10cSrcweir
72cdf0e10cSrcweir	/** is optional for implementation. Used to reflect changes.
73cdf0e10cSrcweir	 */
74cdf0e10cSrcweir	[optional] interface com::sun::star::util::XRefreshable;
75cdf0e10cSrcweir
76cdf0e10cSrcweir	/** optional for implementation. Allows to create descriptor elements which then could be used to append new elements.
77cdf0e10cSrcweir	 */
78cdf0e10cSrcweir	[optional] interface XDataDescriptorFactory;
79cdf0e10cSrcweir
80cdf0e10cSrcweir	/** optional for implementation, provides the possibility of adding
81cdf0e10cSrcweir				a new element to the container.
82cdf0e10cSrcweir	 */
83cdf0e10cSrcweir	[optional] interface XAppend;
84cdf0e10cSrcweir
85cdf0e10cSrcweir	/** optional for implementation, provides the possibility of dropping
86cdf0e10cSrcweir				an element from the container.
87cdf0e10cSrcweir	 */
88cdf0e10cSrcweir	[optional] interface XDrop;
89cdf0e10cSrcweir};
90cdf0e10cSrcweir
91cdf0e10cSrcweir//=============================================================================
92cdf0e10cSrcweir
93cdf0e10cSrcweir}; }; }; };
94cdf0e10cSrcweir
95cdf0e10cSrcweir/*===========================================================================
96cdf0e10cSrcweir===========================================================================*/
97cdf0e10cSrcweir#endif
98