offapi/com/sun/star/sdbcx/IndexDescriptor.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_IndexDescriptor_idl__
  28 #define __com_sun_star_sdbcx_IndexDescriptor_idl__
  29
  30 #ifndef __com_sun_star_sdbcx_Descriptor_idl__
  31 #include <com/sun/star/sdbcx/Descriptor.idl>
  32 #endif
  33
  34  module com {  module sun {  module star {  module sdbcx {
  35
  36  published interface XColumnsSupplier;
  37
  38
  39 /** is used to define a new index for a database table.
  40     @see com::sun::star::sdbcx::Index
  41  */
  42 published service IndexDescriptor
  43 {
  44     service Descriptor;
  45
  46
  47     /** access to the contained index columns.
  48      */
  49     interface XColumnsSupplier;
  50
  51
  52     /** is the name of the index catalog, may be empty.
  53      */
  54     [property] string Catalog;
  55
  56
  57     /** indicates that the index allow only unique values.
  58      */
  59     [property] boolean IsUnique;
  60
  61
  62     /** indicates that the index is clustered.
  63      */
  64     [property] boolean IsClustered;
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 /*===========================================================================
  72 ===========================================================================*/
  73 #endif