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