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

   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_ODBCConnectionProperties_idl__
  28 #define __com_sun_star_sdbc_ODBCConnectionProperties_idl__
  29
  30 #ifndef __com_sun_star_sdbc_ConnectionProperties_idl__
  31 #include <com/sun/star/sdbc/ConnectionProperties.idl>
  32 #endif
  33
  34 module com {  module sun {  module star {  module sdbc {
  35
  36 /** represents the properties for a ODBC 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::ConnectionProperties
  49  */
  50 service ODBCConnectionProperties
  51 {
  52     service com::sun::star::sdbc::ConnectionProperties;
  53     /** should the parameter '?' in prepared statement be substituated with an distinct name
  54     */
  55     [optional, property] boolean ParameterNameSubstitution;
  56
  57     /** the Timeout after which time a timeout should happen
  58     */
  59     [optional, property] long Timeout;
  60
  61     /** Silent - should the connection be silent. No user interaction while creating the connection.
  62     */
  63     [optional, property] boolean Silent;
  64
  65     /** should the driver should support a catalog.
  66     */
  67     [optional, property] boolean UseCatalog;
  68
  69     /** specifies the encoding to use to translate the backend data
  70
  71         <p>See the <a href="http://www.iana.org/assignments/character-sets">IANA character set list</a>
  72         for a list of valid values.</p>
  73     */
  74     [optional, property] string CharSet;
  75
  76     /** specifies if retrieving of auto generated values should be enabled or not.
  77         If <TRUE/> than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not.
  78     */
  79     [optional, property] boolean IsAutoRetrievingEnabled;
  80
  81     /** specifies the statement which should be executed
  82         when asking an "INSERT" statement for the XGeneratedResultSet (future concept) interface.
  83     */
  84     [optional, property] string AutoRetrievingStatement;
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90
  91 /*===========================================================================
  92
  93 ===========================================================================*/
  94 #endif