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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20  module com {  module sun {  module star {  module sdbcx {
  21
  22  published interface XColumnsSupplier;
  23
  24
  25 /** is used to define a new index for a database table.
  26     @see com::sun::star::sdbcx::Index
  27  */
  28 published service IndexDescriptor
  29 {
  30     service Descriptor;
  31
  32
  33     /** access to the contained index columns.
  34      */
  35     interface XColumnsSupplier;
  36
  37
  38     /** is the name of the index catalog, may be empty.
  39      */
  40     [property] string Catalog;
  41
  42
  43     /** indicates that the index allow only unique values.
  44      */
  45     [property] boolean IsUnique;
  46
  47
  48     /** indicates that the index is clustered.
  49      */
  50     [property] boolean IsClustered;
  51 };
  52
  53
  54 }; }; }; };
  55
  56 /*===========================================================================
  57 ===========================================================================*/
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */