summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl')
-rw-r--r--offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl78
1 files changed, 78 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl b/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl
new file mode 100644
index 000000000..99f239596
--- /dev/null
+++ b/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl
@@ -0,0 +1,78 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#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 DatabaseObject or DatabaseObjectContainer 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 DatabaseObjectContainer::CATALOG and
+ DatabaseObjectContainer::SCHEMA, 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 DatabaseObjectContainer::TABLES,
+ DatabaseObjectContainer::QUERIES, DatabaseObjectContainer::DATA_SOURCE,
+ DatabaseObjectContainer::FORMS or DatabaseObjectContainer::REPORTS,
+ this denotes the name of the data source (as denoted by
+ com::sun::star::sdb::DataSource::Name)</p>
+
+ @see XDatabaseMetaData::isCatalogAtStart
+ @see DatabaseObjectContainer
+ */
+ string Name;
+};
+
+
+}; }; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */