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