summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl
blob: 40355368a919b2ceee7ebd04012ff58d7039c347 (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
/* -*- 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_sheet_DatabaseImportDescriptor_idl__
#define __com_sun_star_sheet_DatabaseImportDescriptor_idl__

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


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
        DatabaseImportDescriptor::SourceType attribute.</p>
     */
    [property] string SourceObject;


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

        @since OOo 2.0

     */
    [optional, property] boolean IsNative;


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

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */