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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbc_ODBCConnectionProperties_idl__
  29 #define __com_sun_star_sdbc_ODBCConnectionProperties_idl__
  30
  31 #include <com/sun/star/sdbc/ConnectionProperties.idl>
  32
  33 module com {  module sun {  module star {  module sdbc {
  34
  35 /** represents the properties for a ODBC connection (session) with a specific
  36     database. These properties can be used when calling the method
  37     <member scope="com::sun::star::sdbc">XDriver::connect()</member> or
  38     <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>.
  39
  40     <p>
  41     The properties for a connection contain additional information about how to connect to a database and
  42     how to control the behavior of the resulting connection should be.
  43
  44     </p>
  45     @see com::sun::star::sdbc::XDriver
  46     @see com::sun::star::sdbc::XDriverManager
  47     @see com::sun::star::sdbc::ConnectionProperties
  48  */
  49 service ODBCConnectionProperties
  50 {
  51     service com::sun::star::sdbc::ConnectionProperties;
  52     /** should the parameter "?" in prepared statement be substituted with an distinct name
  53     */
  54     [optional, property] boolean ParameterNameSubstitution;
  55
  56     /** the Timeout after which time a timeout should happen
  57     */
  58     [optional, property] long Timeout;
  59
  60     /** Silent - should the connection be silent. No user interaction while creating the connection.
  61     */
  62     [optional, property] boolean Silent;
  63
  64     /** should the driver should support a catalog.
  65     */
  66     [optional, property] boolean UseCatalog;
  67
  68     /** specifies the encoding to use to translate the backend data
  69
  70         <p>See the <a href="http://www.iana.org/assignments/character-sets">IANA character set list</a>
  71         for a list of valid values.</p>
  72     */
  73     [optional, property] string CharSet;
  74
  75     /** specifies if retrieving of auto generated values should be enabled or not.
  76         If <TRUE/> than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not.
  77     */
  78     [optional, property] boolean IsAutoRetrievingEnabled;
  79
  80     /** specifies the statement which should be executed
  81         when asking an "INSERT" statement for the XGeneratedResultSet (future concept) interface.
  82     */
  83     [optional, property] string AutoRetrievingStatement;
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 /*===========================================================================
  91
  92 ===========================================================================*/
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */