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