1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdb_application_NamedDatabaseObject_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_sdb_application_NamedDatabaseObject_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski//============================================================================= 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module sdb { module application { 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski//============================================================================= 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski/** denotes a named database object, or a named folder of database objects 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski @since OpenOffice 3.0 36*b1cdbd2cSJim Jagielski*/ 37*b1cdbd2cSJim Jagielskistruct NamedDatabaseObject 38*b1cdbd2cSJim Jagielski{ 39*b1cdbd2cSJim Jagielski /** denotes the type of the object. 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski <p>This member is one of the <type>DatabaseObject</type> or <type>DatabaseObjectContainer</type> constants.</p> 42*b1cdbd2cSJim Jagielski */ 43*b1cdbd2cSJim Jagielski long Type; 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski /** denotes the name of the object 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski <p>In case of forms, reports, form folders and report folders, this is the hierarchical 48*b1cdbd2cSJim Jagielski path to the object, where the path elements are separated by a slash (<code>/</code>).</p> 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski <p>In case of tables, this is the fully qualified name of the table, as required 51*b1cdbd2cSJim Jagielski by the database's table name composition rules.</p> 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski <p>In case of queries, this is the name of the query.</p> 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski <p>In case of virtual folders denoted by <member>DatabaseObjectContainer::CATALOG</member> and 56*b1cdbd2cSJim Jagielski <member>DatabaseObjectContainer::SCHEMA</member>, it is 57*b1cdbd2cSJim Jagielski <ul><li><code><schema></code>, if the database supports schemas only</li> 58*b1cdbd2cSJim Jagielski <li><code><catalog></code>, if the database supports catalogs only</li> 59*b1cdbd2cSJim Jagielski <li><code><catalog>.<schema></code>, if the database supports both 60*b1cdbd2cSJim Jagielski catalogs and schemas, and catalogs are to appear at the beginning of an identifier.</li> 61*b1cdbd2cSJim Jagielski <li><code><schema>.<catalog></code>, if the database supports both 62*b1cdbd2cSJim Jagielski catalogs and schemas, and catalogs are to appear at the end of an identifier.</li> 63*b1cdbd2cSJim Jagielski </ul> 64*b1cdbd2cSJim Jagielski </p> 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski <p>In case of the virtual folders denoted by <member>DatabaseObjectContainer::TABLES</member>, 67*b1cdbd2cSJim Jagielski <member>DatabaseObjectContainer::QUERIES</member>, <member>DatabaseObjectContainer::DATA_SOURCE</member>, 68*b1cdbd2cSJim Jagielski <member>DatabaseObjectContainer::FORMS</member> or <member>DatabaseObjectContainer::REPORTS</member>, 69*b1cdbd2cSJim Jagielski this denotes the name of the data source (as denoted by 70*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdb">DataSource::Name</member>)</p> 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski @see XDatabaseMetaData::isCatalogAtStart 73*b1cdbd2cSJim Jagielski @see DatabaseObjectContainer 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski string Name; 76*b1cdbd2cSJim Jagielski}; 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski//============================================================================= 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski}; }; }; }; }; 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski//============================================================================= 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski#endif 85