1/*************************************************************************
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * Copyright 2000, 2010 Oracle and/or its affiliates.
5 *
6 * OpenOffice.org - a multi-platform office productivity suite
7 *
8 * This file is part of OpenOffice.org.
9 *
10 * OpenOffice.org is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License version 3
12 * only, as published by the Free Software Foundation.
13 *
14 * OpenOffice.org is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU Lesser General Public License version 3 for more details
18 * (a copy is included in the LICENSE file that accompanied this code).
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * version 3 along with OpenOffice.org.  If not, see
22 * <http://www.openoffice.org/license.html>
23 * for a copy of the LGPLv3 License.
24 *
25************************************************************************/
26
27#ifndef __com_sun_star_sdb_application_DatabaseObjectContainer_idl__
28#define __com_sun_star_sdb_application_DatabaseObjectContainer_idl__
29
30//=============================================================================
31
32module com { module sun { module star { module sdb { module application {
33
34//=============================================================================
35
36/** denotes different types of (maybe virtual) containers of database objects
37
38    <p>In the database application of OpenOffice.org, database objects (such as
39    tables, queries, forms, reports) can be organized in folders. This hierarchy can
40    be imposed externally, or internally.
41
42    <p>For example, when you connect to a database which supports catalogs and/or schemas,
43    then those impose a natural order on the tables, in that a catalog or a schema
44    is a folder of tables.</p>
45
46    <p>On the other hand, for forms and reports, OpenOffice.org Base itself allows the
47    user to create folders to organize the documents - in this case, the hierarchy is
48    defined in the database document itself.</p>
49
50    @see DatabaseObject
51
52    @since OOo 3.0
53 */
54constants DatabaseObjectContainer
55{
56    /** denotes the virtual folder containing all tables of a database, in a context where such a
57        folder is displayed to the user.
58    */
59    const long TABLES = 1000;
60
61    /** denotes the virtual folder containing all queries of a database, in a context where such a
62        folder is displayed to the user.
63    */
64    const long QUERIES = 1001;
65
66    /** denotes the virtual folder containing all forms of a database document, in a context where such a
67        folder is displayed to the user.
68    */
69    const long FORMS = 1002;
70
71    /** denotes the virtual folder containing all reports of a database database, in a context where such a
72        folder is displayed to the user.
73    */
74    const long REPORTS = 1003;
75
76    /** denotes the data source itself, which effectively is the root container for all other
77        kind of database objects, including other container types.
78    */
79    const long DATA_SOURCE = 1004;
80
81    /** denotes a catalog in a database which supports catalogs
82    */
83    const long CATALOG = 1005;
84
85    /** denotes a schema in a database which supports catalogs
86    */
87    const long SCHEMA = 1006;
88
89    /** denotes a folder which is used to organize forms in a database document
90    */
91    const long FORMS_FOLDER = 1007;
92
93    /** denotes a folder which is used to organize reports in a database document
94    */
95    const long REPORTS_FOLDER = 1008;
96};
97
98//=============================================================================
99
100}; }; }; }; };
101
102//=============================================================================
103
104#endif
105