summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl
blob: 862cf26c5dfbd63e188847e0a55d32d728cfc9c2 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbc_FLATConnectionProperties_idl__
#define __com_sun_star_sdbc_FLATConnectionProperties_idl__

#include <com/sun/star/sdbc/FILEConnectionProperties.idl>

module com {  module sun {  module star {  module sdbc {

/** represents the properties for a FLAT connection (session) with a specific
    database. These properties can be used when calling the method
    <member scope="com::sun::star::sdbc">XDriver::connect()</member> or
    <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>.

    <p>
    The properties for a connection contain additional information about how to connect to a database and
    how to control the behavior of the resulting connection should be.

    </p>
    @see com::sun::star::sdbc::XDriver
    @see com::sun::star::sdbc::XDriverManager
    @see com::sun::star::sdbc::FILEConnectionProperties
 */
service FLATConnectionProperties
{
    service com::sun::star::sdbc::FILEConnectionProperties;

    /** <TRUE/> when the file contains a header line otherwise <FALSE/>
    */
    [optional, property] boolean HeaderLine;

    /** A one character delimiter to separate the fields.
    */
    [optional, property] string FieldDelimiter;

    /** A one character delimiter to separate the strings.
    */
    [optional, property] string StringDelimiter;

    /** A one character delimiter to separate the decimal.
    */
    [optional, property] string DecimalDelimiter;

    /** A one character delimiter to separate the thousands.
    */
    [optional, property] string ThousandDelimiter;

    /** the extension of the files to be used.
    */
    [property] string Extension;
};

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

}; }; }; };

#endif

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