summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl
blob: 79b8a8a458dcf77b803ed14aca91a46ed8c033cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: DatabaseImportDescriptor.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 04:37:34 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_DatabaseImportDescriptor_idl__
#define __com_sun_star_sheet_DatabaseImportDescriptor_idl__

#ifndef __com_sun_star_sheet_DataImportMode_idl__
#include <com/sun/star/sheet/DataImportMode.idl>
#endif

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

module com {  module sun {  module star {  module sheet {

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

/** represents a description of how data from an external database is
    imported.

    @see com::sun::star::sheet::XDatabaseRange
 */
published service DatabaseImportDescriptor
{
    //-------------------------------------------------------------------------

    /** enables importing and specifies from what type of source data is
        imported.
     */
    [property] com::sun::star::sheet::DataImportMode SourceType;

    //-------------------------------------------------------------------------

    /** specifies the name of the database from which data is imported.
     */
    [property] string DatabaseName;

    //-------------------------------------------------------------------------

    /** specifies the table, query, or statement from which data is imported.

        <p>The meaning of this is determined by the
        <member>DatabaseImportDescriptor::SourceType</member> attribute.</p>
     */
    [property] string SourceObject;

    //-------------------------------------------------------------------------

    /** specifies whether the SQL statement is given directly to the database
        or is parsed before.

        @since OOo 2.0.0

     */
    [optional, property] boolean IsNative;

    //-------------------------------------------------------------------------

    /** indicates a connection URL, which locates a database driver.
        @since OOo 2.0.0
     */
    [optional, property] string ConnectionResource;

};

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

}; }; }; };

#endif