xref: /trunk/main/offapi/com/sun/star/sdbc/IndexType.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdbc_IndexType_idl__
28#define __com_sun_star_sdbc_IndexType_idl__
29
30 module com {  module sun {  module star {  module sdbc {
31
32
33/** indicates the type of index.
34 */
35published constants IndexType
36{
37
38	/** A possible value for column
39			<code>TYPE</code>
40			in the
41			<type scope="com::sun::star::sdbc">XResultSet</type>
42			object returned by the method
43			<member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member>
44			.
45			<P>
46			Indentifies table statistics that are returned in conjunction
47			with a table's index description.
48			</P>
49	 */
50	const short STATISTIC = 0;
51	//-------------------------------------------------------------------------
52
53	/** A possible value for column
54			<code>TYPE</code>
55			in the
56			<type scope="com::sun::star::sdbc">XResultSet</type>
57			object returned by the method
58			<member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member>
59			.
60			<P>
61			Indicates that this table index is a clustered index.
62			</P>
63	 */
64	const short CLUSTERED = 1;
65	//-------------------------------------------------------------------------
66
67	/** A possible value for column
68			<code>TYPE</code>
69			in the
70			<type scope="com::sun::star::sdbc">XResultSet</type>
71			object returned by the method
72			<member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member>
73			.
74			 <P>
75			 Indicates that this table index is a hashed index.
76			 </P>
77	 */
78	const short HASHED    = 2;
79	//-------------------------------------------------------------------------
80
81	/** A possible value for column
82			<code>TYPE</code>
83			in the
84			<type scope="com::sun::star::sdbc">XResultSet</type>
85			object returned by the method
86			<member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member>
87			.
88			 <P>
89			 Indicates that this table index is not a clustered
90			 index, a hashed index, or table statistics;
91			 it is something other than these.
92			 </P>
93	 */
94	const short OTHER     = 3;
95};
96
97//=============================================================================
98
99}; }; }; };
100
101/*===========================================================================
102===========================================================================*/
103#endif
104