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_TableDescriptor_idl__
24#define __com_sun_star_sdbcx_TableDescriptor_idl__
25
26#ifndef __com_sun_star_sdbcx_Descriptor_idl__
27#include <com/sun/star/sdbcx/Descriptor.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdbcx {
31
32 published interface XColumnsSupplier;
33 published interface XKeysSupplier;
34
35
36/** is used to define a table of a database. A table is described by its
37	name and one or more columns and the keys for semantic rules.
38
39	<p>
40	In addition, it may contain keys, and to define semantic rules for the table.
41	<b>
42	Note:
43	</b>
44	Indexes can only be appended when the table is already appended at the database.
45	</p>
46	@see com::sun::star::sdbcx::Table
47 */
48published service TableDescriptor
49{
50
51	/** access to the contained table columns.
52	 */
53	interface XColumnsSupplier;
54
55
56	/** optional, provides the access to the table keys.
57	 */
58	[optional] interface XKeysSupplier;
59
60	service Descriptor;
61
62	/** is the name of the table catalog.
63	 */
64	[property] string CatalogName;
65
66
67	/** is the name of the table schema.
68	 */
69	[property] string SchemaName;
70
71
72	/** supplies a comment on the table, Could be emtpy if not supported by
73		the driver.
74	 */
75	[property] string Description;
76};
77
78//=============================================================================
79
80}; }; }; };
81
82/*===========================================================================
83===========================================================================*/
84#endif
85