summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbcx/TableDescriptor.idl
blob: daccd80ee691585f023f021ec33b8bad4a11900c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: TableDescriptor.idl,v $
 * $Revision: 1.11 $
 *
 * 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_TableDescriptor_idl__
#define __com_sun_star_sdbcx_TableDescriptor_idl__

#ifndef __com_sun_star_sdbcx_Descriptor_idl__
#include <com/sun/star/sdbcx/Descriptor.idl>
#endif

 module com {  module sun {  module star {  module sdbcx {

 published interface XColumnsSupplier;
 published interface XKeysSupplier;


/** is used to define a table of a database. A table is described by its
    name and one or more columns and the keys for semantic rules.

    <p>
    In addition, it may contain keys, and to define semantic rules for the table.
    <b>
    Note:
    </b>
    Indexes can only be appended when the table is already appended at the database.
    </p>
    @see com::sun::star::sdbcx::Table
 */
published service TableDescriptor
{

    /** access to the contained table columns.
     */
    interface XColumnsSupplier;


    /** optional, provides the access to the table keys.
     */
    [optional] interface XKeysSupplier;

    service Descriptor;

    /** is the name of the table catalog.
     */
    [property] string CatalogName;


    /** is the name of the table schema.
     */
    [property] string SchemaName;


    /** supplies a comment on the table, Could be emtpy if not supported by
        the driver.
     */
    [property] string Description;
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif