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