summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl
blob: dd1a063e11bdb030f38f9951dc17cd2b2e6bd676 (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
/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_sdbc_FLATConnectionProperties_idl__
#define __com_sun_star_sdbc_FLATConnectionProperties_idl__

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

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 additonal 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 seperate the fields.
    */
    [optional, property] string FieldDelimiter;

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

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

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

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

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

}; }; }; };

/*===========================================================================

===========================================================================*/
#endif