offapi/com/sun/star/sdbcx/Table.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 #ifndef __com_sun_star_sdbcx_Table_idl__
  20 #define __com_sun_star_sdbcx_Table_idl__
  21
  22 #include <com/sun/star/beans/XPropertySet.idl>
  23
  24  module com {  module sun {  module star {  module sdbcx {
  25
  26  published interface XDataDescriptorFactory;
  27  published interface XColumnsSupplier;
  28  published interface XIndexesSupplier;
  29  published interface XKeysSupplier;
  30  published interface XRename;
  31  published interface XAlterTable;
  32
  33
  34 /** used to specify a table in a database. A table is described by its
  35     name and one or more columns.
  36
  37     <p>
  38     In addition, it may contain indexes to improve the performance in
  39     the retrieval of the table's data and keys, and to define semantic rules for the table.
  40     </p>
  41     <p>
  42     <b>
  43     Note:
  44     </b>
  45     All properties and columns of a table could by modified before
  46     it is appended to a database. In that case, the service is in fact a
  47     descriptor. On existing tables, a user might alter columns, add or delete
  48     columns, indexes, and keys depending on the capabilities of the database and on
  49     the user's privileges.
  50     </p>
  51
  52     @see com::sun::star::sdbc::XDatabaseMetaData
  53     @see com::sun::star::sdbcx::Privilege
  54  */
  55 published service Table
  56 {
  57
  58     /** optional, could be used to copy an table.
  59      */
  60     [optional] interface XDataDescriptorFactory;
  61
  62
  63     /** access to the contained table columns.
  64      */
  65     interface XColumnsSupplier;
  66
  67
  68     /** optional, provides the access of the table indexes.
  69      */
  70     [optional] interface XIndexesSupplier;
  71
  72
  73     /** optional, provides the access to the table keys.
  74      */
  75     [optional] interface XKeysSupplier;
  76
  77
  78     /** optional, allows the renaming of tables.
  79      */
  80     [optional] interface XRename;
  81
  82
  83     /** optional, allows the altering of columns.
  84      */
  85     [optional] interface XAlterTable;
  86
  87     // gives access to the properties
  88     interface com::sun::star::beans::XPropertySet;
  89
  90
  91     /** is the name of the table.
  92      */
  93     [readonly, property] string Name;
  94
  95
  96     /** is the name of the table catalog.
  97      */
  98     [readonly, property] string CatalogName;
  99
 100
 101     /** is the name of the table schema.
 102      */
 103     [readonly, property] string SchemaName;
 104
 105
 106     /** supplies a comment on the table. Could be empty, if not supported by
 107         the driver.
 108      */
 109     [readonly, property] string Description;
 110
 111
 112     /** indicates the type of the table like (TABLE, VIEW, SYSTEM TABLE).
 113         Could be empty, if not supported by the driver.
 114      */
 115     [optional, readonly, property] string Type;
 116 };
 117
 118
 119 }; }; }; };
 120
 121 /*===========================================================================
 122 ===========================================================================*/
 123 #endif
 124
 125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */