summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbcx/Index.idl
blob: 95e8b93c8d82c0f582fc74998e15f8de54c2dc25 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*************************************************************************
 *
 *  $RCSfile: Index.idl,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 09:22:00 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbcx_Index_idl__
#define __com_sun_star_sdbcx_Index_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

 module com {  module sun {  module star {  module sdbcx {

interface XColumnsSupplier;
interface XDataDescriptorFactory;


// DocMerge from xml: service com::sun::star::sdbcx::Index
/** is used to specify the index for a database table. It refers to one or
    more columns of a table.


    <p>
    <b>Note:</b>
    All properties and columns of an index could by modified before they are appended
    to a table. In that case the service is a data descriptor.</p>
 */
service Index
{

    // DocMerge from xml: service com::sun::star::sdbcx::Index: interface com::sun::star::sdbcx::XDataDescriptorFactory
    /** optional, could be used to copy an index.
     */
    interface XDataDescriptorFactory;


    // DocMerge from xml: service com::sun::star::sdbcx::Index: interface com::sun::star::sdbcx::XColumnsSupplier
    /** access to the contained index columns.
     */
    interface XColumnsSupplier;

    // DocMerge: empty anyway
    interface com::sun::star::beans::XPropertySet;


    // DocMerge from xml: property com::sun::star::sdbcx::Index::Name
    /** is the name of the index.
     */
    [readonly, property] string Name;


    // DocMerge from xml: property com::sun::star::sdbcx::Index::Catalog
    /** is the name of the index catalog, may be empty.
     */
    [readonly, property] string Catalog;


    // DocMerge from xml: property com::sun::star::sdbcx::Index::IsUnique
    /** indicates that the index allow only unique values.
     */
    [readonly, property] boolean IsUnique;


    // DocMerge from xml: property com::sun::star::sdbcx::Index::IsPrimaryKeyIndex
    /** indicates that the index is used for the primary key.
     */
    [readonly, property] boolean IsPrimaryKeyIndex;


    // DocMerge from xml: property com::sun::star::sdbcx::Index::IsClustered
    /** indicates that the index is clustered.
     */
    [readonly, property] boolean IsClustered;
};

//=============================================================================

}; }; }; };

/*===========================================================================
    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:43  hjs
    initial import

    Revision 1.5  2000/09/11 11:52:44  mi
    documentation merged from XML

    Revision 1.3  1999/12/20 16:26:14  dg
    #70278# new package name

    Revision 1.2  1999/11/29 16:16:05  dg
    Documentation

    Revision 1.1  1999/11/24 08:42:07  dg
    new StarDataDefinitionBeans

===========================================================================*/
#endif