LibreOffice
LibreOffice 7.2 SDK API Reference
Index.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef __com_sun_star_sdbcx_Index_idl__
20 #define __com_sun_star_sdbcx_Index_idl__
21 
23 
24  module com { module sun { module star { module sdbcx {
25 
26  published interface XColumnsSupplier;
27  published interface XDataDescriptorFactory;
28 
29 
40 published service Index
41 {
42 
45  [optional] interface XDataDescriptorFactory;
46 
47 
50  interface XColumnsSupplier;
51 
52  // gives access to the properties.
54 
55 
58  [readonly, property] string Name;
59 
60 
63  [readonly, property] string Catalog;
64 
65 
68  [readonly, property] boolean IsUnique;
69 
70 
73  [readonly, property] boolean IsPrimaryKeyIndex;
74 
75 
78  [readonly, property] boolean IsClustered;
79 };
80 
81 
82 }; }; }; };
83 
84 /*===========================================================================
85 ===========================================================================*/
86 #endif
87 
88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
provides the access to a container of columns, typically used for tables and indexes.
Definition: XColumnsSupplier.idl:35
provides the creation of a descriptor for a definition object.
Definition: XDataDescriptorFactory.idl:33
Definition: Ambiguous.idl:22
is used to specify the index for a database table.
Definition: Index.idl:41
boolean IsClustered
indicates that the index is clustered.
Definition: Index.idl:78
string Name
is the name of the index.
Definition: Index.idl:53
boolean IsPrimaryKeyIndex
indicates that the index is used for the primary key.
Definition: Index.idl:73
string Catalog
is the name of the index catalog, may be empty.
Definition: Index.idl:63
boolean IsUnique
indicates that the index allow only unique values.
Definition: Index.idl:68