offapi/com/sun/star/sdb/application/DatabaseObjectContainer.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module sdb { module application {
  22
  23
  24 /** denotes different types of (maybe virtual) containers of database objects
  25
  26     <p>In the database application of OpenOffice.org, database objects (such as
  27     tables, queries, forms, reports) can be organized in folders. This hierarchy can
  28     be imposed externally, or internally.
  29
  30     <p>For example, when you connect to a database which supports catalogs and/or schemas,
  31     then those impose a natural order on the tables, in that a catalog or a schema
  32     is a folder of tables.</p>
  33
  34     <p>On the other hand, for forms and reports, OpenOffice.org Base itself allows the
  35     user to create folders to organize the documents - in this case, the hierarchy is
  36     defined in the database document itself.</p>
  37
  38     @see DatabaseObject
  39
  40     @since OOo 3.0
  41  */
  42 constants DatabaseObjectContainer
  43 {
  44     /** denotes the virtual folder containing all tables of a database, in a context where such a
  45         folder is displayed to the user.
  46     */
  47     const long TABLES = 1000;
  48
  49     /** denotes the virtual folder containing all queries of a database, in a context where such a
  50         folder is displayed to the user.
  51     */
  52     const long QUERIES = 1001;
  53
  54     /** denotes the virtual folder containing all forms of a database document, in a context where such a
  55         folder is displayed to the user.
  56     */
  57     const long FORMS = 1002;
  58
  59     /** denotes the virtual folder containing all reports of a database, in a context where such a
  60         folder is displayed to the user.
  61     */
  62     const long REPORTS = 1003;
  63
  64     /** denotes the data source itself, which effectively is the root container for all other
  65         kind of database objects, including other container types.
  66     */
  67     const long DATA_SOURCE = 1004;
  68
  69     /** denotes a catalog in a database which supports catalogs
  70     */
  71     const long CATALOG = 1005;
  72
  73     /** denotes a schema in a database which supports schemas
  74     */
  75     const long SCHEMA = 1006;
  76
  77     /** denotes a folder which is used to organize forms in a database document
  78     */
  79     const long FORMS_FOLDER = 1007;
  80
  81     /** denotes a folder which is used to organize reports in a database document
  82     */
  83     const long REPORTS_FOLDER = 1008;
  84 };
  85
  86
  87 }; }; }; }; };
  88
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */