offapi/com/sun/star/sdb/application/NamedDatabaseObject.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: NamedDatabaseObject.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_NamedDatabaseObject_idl__
  31 #define __com_sun_star_sdb_application_NamedDatabaseObject_idl__
  32
  33 //=============================================================================
  34
  35 module com { module sun { module star { module sdb { module application {
  36
  37 //=============================================================================
  38
  39 /** denotes a named database object, or a named folder of database objects
  40
  41     @since OOo 3.0
  42 */
  43 struct NamedDatabaseObject
  44 {
  45     /** denotes the type of the object.
  46
  47         <p>This member is one of the <type>DatabaseObject</type> or <type>DatabaseObjectContainer</type> constants.</p>
  48     */
  49     long    Type;
  50
  51     /** denotes the name of the object
  52
  53         <p>In case of forms, reports, form folders and report folders, this is the hierarchical
  54         path to the object, where the path elements are separated by a slash (<code>/</code>).</p>
  55
  56         <p>In case of tables, this is the fully qualified name of the table, as required
  57         by the database's table name composition rules.</p>
  58
  59         <p>In case of queries, this is the name of the query.</p>
  60
  61         <p>In case of virtual folders denoted by <member>DatabaseObjectContainer::CATALOG</member> and
  62         <member>DatabaseObjectContainer::SCHEMA</member>, it is
  63         <ul><li><code>&lt;schema&gt;</code>, if the database supports schemas only</li>
  64             <li><code>&lt;catalog&gt;</code>, if the database supports catalogs only</li>
  65             <li><code>&lt;catalog&gt;.&lt;schema&gt;</code>, if the database supports both
  66             catalogs and schemas, and catalogs are to appear at the beginning of an identifier.</li>
  67             <li><code>&lt;schema&gt;.&lt;catalog&gt;</code>, if the database supports both
  68             catalogs and schemas, and catalogs are to appear at the end of an identifier.</li>
  69         </ul>
  70         </p>
  71
  72         <p>In case of the virtual folders denoted by <member>DatabaseObjectContainer::TABLES</member>,
  73         <member>DatabaseObjectContainer::QUERIES</member>, <member>DatabaseObjectContainer::DATA_SOURCE</member>,
  74         <member>DatabaseObjectContainer::FORMS</member> or <member>DatabaseObjectContainer::REPORTS</member>,
  75         this denotes the name of the data source (as denoted by
  76         <member scope="com::sun::star::sdb">DataSource::Name</member>)</p>
  77
  78         @see XDatabaseMetaData::isCatalogAtStart
  79         @see DatabaseObjectContainer
  80     */
  81     string  Name;
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; }; };
  87
  88 //=============================================================================
  89
  90 #endif