1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbc_FLATConnectionProperties_idl__
24#define __com_sun_star_sdbc_FLATConnectionProperties_idl__
25
26#ifndef __com_sun_star_sdbc_FILEConnectionProperties_idl__
27#include <com/sun/star/sdbc/FILEConnectionProperties.idl>
28#endif
29
30module com {  module sun {  module star {  module sdbc {
31
32/** represents the properties for a FLAT connection (session) with a specific
33	database. These properties can be used when calling the method
34	<member scope="com::sun::star::sdbc">XDriver::connect()</member> or
35	<member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>.
36
37	<p>
38	The properties for a connection contain additonal information about how to connect to a database and
39	how to control the behavior of the resulting connection should be.
40
41	</p>
42	@see com::sun::star::sdbc::XDriver
43	@see com::sun::star::sdbc::XDriverManager
44	@see com::sun::star::sdbc::FILEConnectionProperties
45 */
46service FLATConnectionProperties
47{
48	service com::sun::star::sdbc::FILEConnectionProperties;
49
50	/** <TRUE/> when the file contains a header line otherwise <FALSE/>
51	*/
52	[optional, property] boolean HeaderLine;
53
54	/** A one character delimiter to seperate the fields.
55	*/
56	[optional, property] string FieldDelimiter;
57
58	/** A one character delimiter to seperate the strings.
59	*/
60	[optional, property] string StringDelimiter;
61
62	/** A one character delimiter to seperate the decimal.
63	*/
64	[optional, property] string DecimalDelimiter;
65
66	/** A one character delimiter to seperate the thousands.
67	*/
68	[optional, property] string ThousandDelimiter;
69
70	/** the extension of the files to be used.
71	*/
72	[property] string Extension;
73};
74
75//=============================================================================
76
77}; }; }; };
78
79/*===========================================================================
80
81===========================================================================*/
82#endif
83