xref: /aoo42x/main/offapi/com/sun/star/sdbcx/Index.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_Index_idl__
24#define __com_sun_star_sdbcx_Index_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdbcx {
31
32 published interface XColumnsSupplier;
33 published interface XDataDescriptorFactory;
34
35
36/** is used to specify the index for a database table. It refers to one or
37	more columns of a table.
38	<p>
39	<b>
40	Note:
41	</b>
42	All properties and columns of an index could by modified before they are appended
43	to a table. In that case the service is a data descriptor.
44	</p>
45 */
46published service Index
47{
48
49	/** optional, could be used to copy an index.
50	 */
51	[optional] interface XDataDescriptorFactory;
52
53
54	/** access to the contained index columns.
55	 */
56	interface XColumnsSupplier;
57
58	// gives access to the properties.
59	interface com::sun::star::beans::XPropertySet;
60
61
62	/** is the name of the index.
63	 */
64	[readonly, property] string Name;
65
66
67	/** is the name of the index catalog, may be empty.
68	 */
69	[readonly, property] string Catalog;
70
71
72	/** indicates that the index allow only unique values.
73	 */
74	[readonly, property] boolean IsUnique;
75
76
77	/** indicates that the index is used for the primary key.
78	 */
79	[readonly, property] boolean IsPrimaryKeyIndex;
80
81
82	/** indicates that the index is clustered.
83	 */
84	[readonly, property] boolean IsClustered;
85};
86
87//=============================================================================
88
89}; }; }; };
90
91/*===========================================================================
92===========================================================================*/
93#endif
94