offapi/com/sun/star/sdbcx/TableDescriptor.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_TableDescriptor_idl__
  28 #define __com_sun_star_sdbcx_TableDescriptor_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  published interface XKeysSupplier;
  38
  39
  40 /** is used to define a table of a database. A table is described by its
  41     name and one or more columns and the keys for semantic rules.
  42
  43     <p>
  44     In addition, it may contain keys, and to define semantic rules for the table.
  45     <b>
  46     Note:
  47     </b>
  48     Indexes can only be appended when the table is already appended at the database.
  49     </p>
  50     @see com::sun::star::sdbcx::Table
  51  */
  52 published service TableDescriptor
  53 {
  54
  55     /** access to the contained table columns.
  56      */
  57     interface XColumnsSupplier;
  58
  59
  60     /** optional, provides the access to the table keys.
  61      */
  62     [optional] interface XKeysSupplier;
  63
  64     service Descriptor;
  65
  66     /** is the name of the table catalog.
  67      */
  68     [property] string CatalogName;
  69
  70
  71     /** is the name of the table schema.
  72      */
  73     [property] string SchemaName;
  74
  75
  76     /** supplies a comment on the table, Could be emtpy if not supported by
  77         the driver.
  78      */
  79     [property] string Description;
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 /*===========================================================================
  87 ===========================================================================*/
  88 #endif