xref: /trunk/main/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdbc_FLATConnectionProperties_idl__
28#define __com_sun_star_sdbc_FLATConnectionProperties_idl__
29
30#ifndef __com_sun_star_sdbc_FILEConnectionProperties_idl__
31#include <com/sun/star/sdbc/FILEConnectionProperties.idl>
32#endif
33
34module com {  module sun {  module star {  module sdbc {
35
36/** represents the properties for a FLAT connection (session) with a specific
37    database. These properties can be used when calling the method
38    <member scope="com::sun::star::sdbc">XDriver::connect()</member> or
39    <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>.
40
41    <p>
42    The properties for a connection contain additonal information about how to connect to a database and
43    how to control the behavior of the resulting connection should be.
44
45    </p>
46    @see com::sun::star::sdbc::XDriver
47    @see com::sun::star::sdbc::XDriverManager
48    @see com::sun::star::sdbc::FILEConnectionProperties
49 */
50service FLATConnectionProperties
51{
52    service com::sun::star::sdbc::FILEConnectionProperties;
53
54    /** <TRUE/> when the file contains a header line otherwise <FALSE/>
55    */
56    [optional, property] boolean HeaderLine;
57
58    /** A one character delimiter to seperate the fields.
59    */
60    [optional, property] string FieldDelimiter;
61
62    /** A one character delimiter to seperate the strings.
63    */
64    [optional, property] string StringDelimiter;
65
66    /** A one character delimiter to seperate the decimal.
67    */
68    [optional, property] string DecimalDelimiter;
69
70    /** A one character delimiter to seperate the thousands.
71    */
72    [optional, property] string ThousandDelimiter;
73
74    /** the extension of the files to be used.
75    */
76    [property] string Extension;
77};
78
79//=============================================================================
80
81}; }; }; };
82
83/*===========================================================================
84
85===========================================================================*/
86#endif
87