132 lines
3.8 KiB
Text
132 lines
3.8 KiB
Text
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2000, 2010 Oracle and/or its affiliates.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* This file is part of OpenOffice.org.
|
|
*
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
* only, as published by the Free Software Foundation.
|
|
*
|
|
* OpenOffice.org is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License version 3 for more details
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
* <http://www.openoffice.org/license.html>
|
|
* for a copy of the LGPLv3 License.
|
|
*
|
|
************************************************************************/
|
|
#ifndef __com_sun_star_sdbcx_Table_idl__
|
|
#define __com_sun_star_sdbcx_Table_idl__
|
|
|
|
#include <com/sun/star/beans/XPropertySet.idl>
|
|
|
|
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 an 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;
|
|
};
|
|
|
|
//=============================================================================
|
|
|
|
}; }; }; };
|
|
|
|
/*===========================================================================
|
|
===========================================================================*/
|
|
#endif
|