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