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

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