xref: /AOO41X/main/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl (revision fbef625e460ef3feded438b39e36a4c8f360d8f1)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_DatabaseImportDescriptor_idl__
25#define __com_sun_star_sheet_DatabaseImportDescriptor_idl__
26
27#ifndef __com_sun_star_sheet_DataImportMode_idl__
28#include <com/sun/star/sheet/DataImportMode.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module sheet {
34
35//=============================================================================
36
37/** represents a description of how data from an external database is
38    imported.
39
40    @see com::sun::star::sheet::XDatabaseRange
41 */
42published service DatabaseImportDescriptor
43{
44    //-------------------------------------------------------------------------
45
46    /** enables importing and specifies from what type of source data is
47        imported.
48     */
49    [property] com::sun::star::sheet::DataImportMode SourceType;
50
51    //-------------------------------------------------------------------------
52
53    /** specifies the name of the database from which data is imported.
54     */
55    [property] string DatabaseName;
56
57    //-------------------------------------------------------------------------
58
59    /** specifies the table, query, or statement from which data is imported.
60
61        <p>The meaning of this is determined by the
62        <member>DatabaseImportDescriptor::SourceType</member> attribute.</p>
63     */
64    [property] string SourceObject;
65
66    //-------------------------------------------------------------------------
67
68    /** specifies whether the SQL statement is given directly to the database
69        or is parsed before.
70
71        @since OpenOffice 2.0
72
73     */
74    [optional, property] boolean IsNative;
75
76    //-------------------------------------------------------------------------
77
78    /** indicates a connection URL, which locates a database driver.
79        @since OpenOffice 2.0
80     */
81    [optional, property] string ConnectionResource;
82
83};
84
85//=============================================================================
86
87}; }; }; };
88
89#endif
90
91