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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com {  module sun {  module star {  module sdbc {
  21
  22 /** represents the properties for an ODBC connection (session) with a specific
  23     database. These properties can be used when calling the method
  24     com::sun::star::sdbc::XDriver::connect() or
  25     com::sun::star::sdbc::XDriverManager::getConnectionWithInfo().
  26
  27     <p>
  28     The properties for a connection contain additional information about how to connect to a database and
  29     how to control the behavior of the resulting connection should be.
  30
  31     </p>
  32     @see com::sun::star::sdbc::XDriver
  33     @see com::sun::star::sdbc::XDriverManager
  34     @see com::sun::star::sdbc::ConnectionProperties
  35  */
  36 service ODBCConnectionProperties
  37 {
  38     service com::sun::star::sdbc::ConnectionProperties;
  39     /** should the parameter "?" in prepared statement be substituted with an distinct name
  40     */
  41     [optional, property] boolean ParameterNameSubstitution;
  42
  43     /** the Timeout after which time a timeout should happen
  44     */
  45     [optional, property] long Timeout;
  46
  47     /** Silent - should the connection be silent. No user interaction while creating the connection.
  48     */
  49     [optional, property] boolean Silent;
  50
  51     /** should the driver should support a catalog.
  52     */
  53     [optional, property] boolean UseCatalog;
  54
  55     /** specifies the encoding to use to translate the backend data
  56
  57         <p>See the <a href="http://www.iana.org/assignments/character-sets">IANA character set list</a>
  58         for a list of valid values.</p>
  59     */
  60     [optional, property] string CharSet;
  61
  62     /** specifies if retrieving of auto generated values should be enabled or not.
  63         If `TRUE` than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not.
  64     */
  65     [optional, property] boolean IsAutoRetrievingEnabled;
  66
  67     /** specifies the statement which should be executed
  68         when asking an "INSERT" statement for the XGeneratedResultSet (future concept) interface.
  69     */
  70     [optional, property] string AutoRetrievingStatement;
  71 };
  72
  73
  74 }; }; }; };
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */