/*************************************************************************
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
************************************************************************/

#ifndef __com_sun_star_sdb_application_NamedDatabaseObject_idl__
#define __com_sun_star_sdb_application_NamedDatabaseObject_idl__

//=============================================================================

module com { module sun { module star { module sdb { module application {

//=============================================================================

/** denotes a named database object, or a named folder of database objects

    @since OOo 3.0
*/
struct NamedDatabaseObject
{
    /** denotes the type of the object.

        <p>This member is one of the <type>DatabaseObject</type> or <type>DatabaseObjectContainer</type> constants.</p>
    */
    long    Type;

    /** denotes the name of the object

        <p>In case of forms, reports, form folders and report folders, this is the hierarchical
        path to the object, where the path elements are separated by a slash (<code>/</code>).</p>

        <p>In case of tables, this is the fully qualified name of the table, as required
        by the database's table name composition rules.</p>

        <p>In case of queries, this is the name of the query.</p>

        <p>In case of virtual folders denoted by <member>DatabaseObjectContainer::CATALOG</member> and
        <member>DatabaseObjectContainer::SCHEMA</member>, it is
        <ul><li><code>&lt;schema&gt;</code>, if the database supports schemas only</li>
            <li><code>&lt;catalog&gt;</code>, if the database supports catalogs only</li>
            <li><code>&lt;catalog&gt;.&lt;schema&gt;</code>, if the database supports both
            catalogs and schemas, and catalogs are to appear at the beginning of an identifier.</li>
            <li><code>&lt;schema&gt;.&lt;catalog&gt;</code>, if the database supports both
            catalogs and schemas, and catalogs are to appear at the end of an identifier.</li>
        </ul>
        </p>

        <p>In case of the virtual folders denoted by <member>DatabaseObjectContainer::TABLES</member>,
        <member>DatabaseObjectContainer::QUERIES</member>, <member>DatabaseObjectContainer::DATA_SOURCE</member>,
        <member>DatabaseObjectContainer::FORMS</member> or <member>DatabaseObjectContainer::REPORTS</member>,
        this denotes the name of the data source (as denoted by
        <member scope="com::sun::star::sdb">DataSource::Name</member>)</p>

        @see XDatabaseMetaData::isCatalogAtStart
        @see DatabaseObjectContainer
    */
    string  Name;
};

//=============================================================================

}; }; }; }; };

//=============================================================================

#endif
