LibreOffice: com/sun/star/sdbcx/Index.idl Source File

LibreOffice LibreOffice 26.2 SDK API Reference

Loading...
Searching...
No Matches
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
20 module com { module sun { module star { module sdbcx {
21
22 published interface XColumnsSupplier;
23 published interface XDataDescriptorFactory;
24
25
36published service Index
37{
38
41 [optional] interface XDataDescriptorFactory;
42
43
46 interface XColumnsSupplier;
47
48 // gives access to the properties.
49 interface com::sun::star::beans::XPropertySet;
50
51
54 [readonly, property] string Name;
55
56
59 [readonly, property] string Catalog;
60
61
64 [readonly, property] boolean IsUnique;
65
66
69 [readonly, property] boolean IsPrimaryKeyIndex;
70
71
74 [readonly, property] boolean IsClustered;
75};
76
77
78}; }; }; };
79
80/*===========================================================================
81===========================================================================*/
82
83/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition XPropertySet.idl:46
com
Definition Ambiguous.idl:20
com::sun::star::sdbcx::Index
is used to specify the index for a database table.
Definition Index.idl:37
com::sun::star::sdbcx::Index::XDataDescriptorFactory
interface XDataDescriptorFactory
optional, could be used to copy an index.
Definition Index.idl:41
com::sun::star::sdbcx::Index::IsClustered
boolean IsClustered
indicates that the index is clustered.
Definition Index.idl:74
com::sun::star::sdbcx::Index::Name
string Name
is the name of the index.
Definition Index.idl:54
com::sun::star::sdbcx::Index::IsPrimaryKeyIndex
boolean IsPrimaryKeyIndex
indicates that the index is used for the primary key.
Definition Index.idl:69
com::sun::star::sdbcx::Index::XColumnsSupplier
interface XColumnsSupplier
access to the contained index columns.
Definition Index.idl:46
com::sun::star::sdbcx::Index::Catalog
string Catalog
is the name of the index catalog, may be empty.
Definition Index.idl:59
com::sun::star::sdbcx::Index::IsUnique
boolean IsUnique
indicates that the index allow only unique values.
Definition Index.idl:64