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