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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sdbcx_Index_idl__
  28 #define __com_sun_star_sdbcx_Index_idl__
  29
  30 #ifndef __com_sun_star_beans_XPropertySet_idl__
  31 #include <com/sun/star/beans/XPropertySet.idl>
  32 #endif
  33
  34  module com {  module sun {  module star {  module sdbcx {
  35
  36  published interface XColumnsSupplier;
  37  published interface XDataDescriptorFactory;
  38
  39
  40 /** is used to specify the index for a database table. It refers to one or
  41     more columns of a table.
  42     <p>
  43     <b>
  44     Note:
  45     </b>
  46     All properties and columns of an index could by modified before they are appended
  47     to a table. In that case the service is a data descriptor.
  48     </p>
  49  */
  50 published service Index
  51 {
  52
  53     /** optional, could be used to copy an index.
  54      */
  55     [optional] interface XDataDescriptorFactory;
  56
  57
  58     /** access to the contained index columns.
  59      */
  60     interface XColumnsSupplier;
  61
  62     // gives access to the properties.
  63     interface com::sun::star::beans::XPropertySet;
  64
  65
  66     /** is the name of the index.
  67      */
  68     [readonly, property] string Name;
  69
  70
  71     /** is the name of the index catalog, may be empty.
  72      */
  73     [readonly, property] string Catalog;
  74
  75
  76     /** indicates that the index allow only unique values.
  77      */
  78     [readonly, property] boolean IsUnique;
  79
  80
  81     /** indicates that the index is used for the primary key.
  82      */
  83     [readonly, property] boolean IsPrimaryKeyIndex;
  84
  85
  86     /** indicates that the index is clustered.
  87      */
  88     [readonly, property] boolean IsClustered;
  89 };
  90
  91 //=============================================================================
  92
  93 }; }; }; };
  94
  95 /*===========================================================================
  96 ===========================================================================*/
  97 #endif