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