xref: /aoo4110/main/offapi/com/sun/star/sdbc/IndexType.idl (revision b1cdbd2c)
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_sdbc_IndexType_idl__
24#define __com_sun_star_sdbc_IndexType_idl__
25
26 module com {  module sun {  module star {  module sdbc {
27
28
29/** indicates the type of index.
30 */
31published constants IndexType
32{
33
34	/** A possible value for column
35			<code>TYPE</code>
36			in the
37			<type scope="com::sun::star::sdbc">XResultSet</type>
38			object returned by the method
39			<member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member>
40			.
41			<P>
42			Indentifies table statistics that are returned in conjunction
43			with a table's index description.
44			</P>
45	 */
46	const short STATISTIC = 0;
47	//-------------------------------------------------------------------------
48
49	/** A possible value for column
50			<code>TYPE</code>
51			in the
52			<type scope="com::sun::star::sdbc">XResultSet</type>
53			object returned by the method
54			<member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member>
55			.
56			<P>
57			Indicates that this table index is a clustered index.
58			</P>
59	 */
60	const short CLUSTERED = 1;
61	//-------------------------------------------------------------------------
62
63	/** A possible value for column
64			<code>TYPE</code>
65			in the
66			<type scope="com::sun::star::sdbc">XResultSet</type>
67			object returned by the method
68			<member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member>
69			.
70			 <P>
71			 Indicates that this table index is a hashed index.
72			 </P>
73	 */
74	const short HASHED    = 2;
75	//-------------------------------------------------------------------------
76
77	/** A possible value for column
78			<code>TYPE</code>
79			in the
80			<type scope="com::sun::star::sdbc">XResultSet</type>
81			object returned by the method
82			<member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member>
83			.
84			 <P>
85			 Indicates that this table index is not a clustered
86			 index, a hashed index, or table statistics;
87			 it is something other than these.
88			 </P>
89	 */
90	const short OTHER     = 3;
91};
92
93//=============================================================================
94
95}; }; }; };
96
97/*===========================================================================
98===========================================================================*/
99#endif
100