1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sdb_application_NamedDatabaseObject_idl__
25#define __com_sun_star_sdb_application_NamedDatabaseObject_idl__
26
27//=============================================================================
28
29module com { module sun { module star { module sdb { module application {
30
31//=============================================================================
32
33/** denotes a named database object, or a named folder of database objects
34
35    @since OOo 3.0
36*/
37struct NamedDatabaseObject
38{
39    /** denotes the type of the object.
40
41        <p>This member is one of the <type>DatabaseObject</type> or <type>DatabaseObjectContainer</type> constants.</p>
42    */
43    long    Type;
44
45    /** denotes the name of the object
46
47        <p>In case of forms, reports, form folders and report folders, this is the hierarchical
48        path to the object, where the path elements are separated by a slash (<code>/</code>).</p>
49
50        <p>In case of tables, this is the fully qualified name of the table, as required
51        by the database's table name composition rules.</p>
52
53        <p>In case of queries, this is the name of the query.</p>
54
55        <p>In case of virtual folders denoted by <member>DatabaseObjectContainer::CATALOG</member> and
56        <member>DatabaseObjectContainer::SCHEMA</member>, it is
57        <ul><li><code>&lt;schema&gt;</code>, if the database supports schemas only</li>
58            <li><code>&lt;catalog&gt;</code>, if the database supports catalogs only</li>
59            <li><code>&lt;catalog&gt;.&lt;schema&gt;</code>, if the database supports both
60            catalogs and schemas, and catalogs are to appear at the beginning of an identifier.</li>
61            <li><code>&lt;schema&gt;.&lt;catalog&gt;</code>, if the database supports both
62            catalogs and schemas, and catalogs are to appear at the end of an identifier.</li>
63        </ul>
64        </p>
65
66        <p>In case of the virtual folders denoted by <member>DatabaseObjectContainer::TABLES</member>,
67        <member>DatabaseObjectContainer::QUERIES</member>, <member>DatabaseObjectContainer::DATA_SOURCE</member>,
68        <member>DatabaseObjectContainer::FORMS</member> or <member>DatabaseObjectContainer::REPORTS</member>,
69        this denotes the name of the data source (as denoted by
70        <member scope="com::sun::star::sdb">DataSource::Name</member>)</p>
71
72        @see XDatabaseMetaData::isCatalogAtStart
73        @see DatabaseObjectContainer
74    */
75    string  Name;
76};
77
78//=============================================================================
79
80}; }; }; }; };
81
82//=============================================================================
83
84#endif
85