/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at
http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at
http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module sdbcx {
published interface XDataDescriptorFactory;
published interface XColumnsSupplier;
published interface XIndexesSupplier;
published interface XKeysSupplier;
published interface XRename;
published interface XAlterTable;
/** used to specify a table in a database. A table is described by its
name and one or more columns.
<p>
In addition, it may contain indexes to improve the performance in
the retrieval of the table's data and keys, and to define semantic rules for the table.
</p>
<p>
<b>
Note:
</b>
All properties and columns of a table could by modified before
it is appended to a database. In that case, the service is in fact a
descriptor. On existing tables, a user might alter columns, add or delete
columns, indexes, and keys depending on the capabilities of the database and on
the user's privileges.
</p>
@see com::sun::star::sdbc::XDatabaseMetaData
@see com::sun::star::sdbcx::Privilege
*/
published service Table
{
/** optional, could be used to copy a table.
*/
[optional] interface XDataDescriptorFactory;
/** access to the contained table columns.
*/
interface XColumnsSupplier;
/** optional, provides the access of the table indexes.
*/
[optional] interface XIndexesSupplier;
/** optional, provides the access to the table keys.
*/
[optional] interface XKeysSupplier;
/** optional, allows the renaming of tables.
*/
[optional] interface XRename;
/** optional, allows the altering of columns.
*/
[optional] interface XAlterTable;
// gives access to the properties
interface com::sun::star::beans::XPropertySet;
/** is the name of the table.
*/
[readonly, property] string Name;
/** is the name of the table catalog.
*/
[readonly, property] string CatalogName;
/** is the name of the table schema.
*/
[readonly, property] string SchemaName;
/** supplies a comment on the table. Could be empty, if not supported by
the driver.
*/
[readonly, property] string Description;
/** indicates the type of the table like (TABLE, VIEW, SYSTEM TABLE).
Could be empty, if not supported by the driver.
*/
[optional, readonly, property] string Type;
};
}; }; }; };
/*===========================================================================
===========================================================================*/
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
