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_DatabaseObjectContainer_idl__
25#define __com_sun_star_sdb_application_DatabaseObjectContainer_idl__
26
27//=============================================================================
28
29module com { module sun { module star { module sdb { module application {
30
31//=============================================================================
32
33/** denotes different types of (maybe virtual) containers of database objects
34
35    <p>In the database application of OpenOffice.org, database objects (such as
36    tables, queries, forms, reports) can be organized in folders. This hierarchy can
37    be imposed externally, or internally.
38
39    <p>For example, when you connect to a database which supports catalogs and/or schemas,
40    then those impose a natural order on the tables, in that a catalog or a schema
41    is a folder of tables.</p>
42
43    <p>On the other hand, for forms and reports, OpenOffice.org Base itself allows the
44    user to create folders to organize the documents - in this case, the hierarchy is
45    defined in the database document itself.</p>
46
47    @see DatabaseObject
48
49    @since OpenOffice 3.0
50 */
51constants DatabaseObjectContainer
52{
53    /** denotes the virtual folder containing all tables of a database, in a context where such a
54        folder is displayed to the user.
55    */
56    const long TABLES = 1000;
57
58    /** denotes the virtual folder containing all queries of a database, in a context where such a
59        folder is displayed to the user.
60    */
61    const long QUERIES = 1001;
62
63    /** denotes the virtual folder containing all forms of a database document, in a context where such a
64        folder is displayed to the user.
65    */
66    const long FORMS = 1002;
67
68    /** denotes the virtual folder containing all reports of a database database, in a context where such a
69        folder is displayed to the user.
70    */
71    const long REPORTS = 1003;
72
73    /** denotes the data source itself, which effectively is the root container for all other
74        kind of database objects, including other container types.
75    */
76    const long DATA_SOURCE = 1004;
77
78    /** denotes a catalog in a database which supports catalogs
79    */
80    const long CATALOG = 1005;
81
82    /** denotes a schema in a database which supports catalogs
83    */
84    const long SCHEMA = 1006;
85
86    /** denotes a folder which is used to organize forms in a database document
87    */
88    const long FORMS_FOLDER = 1007;
89
90    /** denotes a folder which is used to organize reports in a database document
91    */
92    const long REPORTS_FOLDER = 1008;
93};
94
95//=============================================================================
96
97}; }; }; }; };
98
99//=============================================================================
100
101#endif
102