offapi/com/sun/star/sdbcx/Index.idl

   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
  26 /** is used to specify the index for a database table. It refers to one or
  27     more columns of a table.
  28     <p>
  29     <b>
  30     Note:
  31     </b>
  32     All properties and columns of an index could by modified before they are appended
  33     to a table. In that case the service is a data descriptor.
  34     </p>
  35  */
  36 published service Index
  37 {
  38
  39     /** optional, could be used to copy an index.
  40      */
  41     [optional] interface XDataDescriptorFactory;
  42
  43
  44     /** access to the contained index columns.
  45      */
  46     interface XColumnsSupplier;
  47
  48     // gives access to the properties.
  49     interface com::sun::star::beans::XPropertySet;
  50
  51
  52     /** is the name of the index.
  53      */
  54     [readonly, property] string Name;
  55
  56
  57     /** is the name of the index catalog, may be empty.
  58      */
  59     [readonly, property] string Catalog;
  60
  61
  62     /** indicates that the index allow only unique values.
  63      */
  64     [readonly, property] boolean IsUnique;
  65
  66
  67     /** indicates that the index is used for the primary key.
  68      */
  69     [readonly, property] boolean IsPrimaryKeyIndex;
  70
  71
  72     /** indicates that the index is clustered.
  73      */
  74     [readonly, property] boolean IsClustered;
  75 };
  76
  77
  78 }; }; }; };
  79
  80 /*===========================================================================
  81 ===========================================================================*/
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */