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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbcx_IndexDescriptor_idl__
  29 #define __com_sun_star_sdbcx_IndexDescriptor_idl__
  30
  31 #include <com/sun/star/sdbcx/Descriptor.idl>
  32
  33  module com {  module sun {  module star {  module sdbcx {
  34
  35  published interface XColumnsSupplier;
  36
  37
  38 /** is used to define a new index for a database table.
  39     @see com::sun::star::sdbcx::Index
  40  */
  41 published service IndexDescriptor
  42 {
  43     service Descriptor;
  44
  45
  46     /** access to the contained index columns.
  47      */
  48     interface XColumnsSupplier;
  49
  50
  51     /** is the name of the index catalog, may be empty.
  52      */
  53     [property] string Catalog;
  54
  55
  56     /** indicates that the index allow only unique values.
  57      */
  58     [property] boolean IsUnique;
  59
  60
  61     /** indicates that the index is clustered.
  62      */
  63     [property] boolean IsClustered;
  64 };
  65
  66 //=============================================================================
  67
  68 }; }; }; };
  69
  70 /*===========================================================================
  71 ===========================================================================*/
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */