offapi/com/sun/star/sdbc/FLATConnectionProperties.idl

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