offapi/com/sun/star/sdbcx/Index.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_Index_idl__
  29 #define __com_sun_star_sdbcx_Index_idl__
  30
  31 #include <com/sun/star/beans/XPropertySet.idl>
  32
  33  module com {  module sun {  module star {  module sdbcx {
  34
  35  published interface XColumnsSupplier;
  36  published interface XDataDescriptorFactory;
  37
  38
  39 /** is used to specify the index for a database table. It refers to one or
  40     more columns of a table.
  41     <p>
  42     <b>
  43     Note:
  44     </b>
  45     All properties and columns of an index could by modified before they are appended
  46     to a table. In that case the service is a data descriptor.
  47     </p>
  48  */
  49 published service Index
  50 {
  51
  52     /** optional, could be used to copy an index.
  53      */
  54     [optional] interface XDataDescriptorFactory;
  55
  56
  57     /** access to the contained index columns.
  58      */
  59     interface XColumnsSupplier;
  60
  61     // gives access to the properties.
  62     interface com::sun::star::beans::XPropertySet;
  63
  64
  65     /** is the name of the index.
  66      */
  67     [readonly, property] string Name;
  68
  69
  70     /** is the name of the index catalog, may be empty.
  71      */
  72     [readonly, property] string Catalog;
  73
  74
  75     /** indicates that the index allow only unique values.
  76      */
  77     [readonly, property] boolean IsUnique;
  78
  79
  80     /** indicates that the index is used for the primary key.
  81      */
  82     [readonly, property] boolean IsPrimaryKeyIndex;
  83
  84
  85     /** indicates that the index is clustered.
  86      */
  87     [readonly, property] boolean IsClustered;
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 /*===========================================================================
  95 ===========================================================================*/
  96 #endif
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */