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

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