offapi/com/sun/star/sdbc/JDBCConnectionProperties.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 a JDBC 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 JDBCConnectionProperties
  37 {
  38     service com::sun::star::sdbc::ConnectionProperties;
  39
  40     /** which JDBC driver class should be loaded to create the connection.
  41
  42         @see com::sun::star::sdbc::JDBCConnectionProperties::JavaDriverClassPath
  43     */
  44     [optional, property] string JavaDriverClass;
  45
  46     /** an optional class path to locate the
  47         com::sun::star::sdbc::JDBCConnectionProperties::JavaDriverClass
  48
  49         <p>The class path is a list of zero or more internal (see the
  50         com::sun::star::uri::ExternalUriReferenceTranslator
  51         service) URI references, where any space characters
  52         (<code>U+0020</code>) are ignored (and, in particular, separate adjacent
  53         URI references).  Any &ldquo;vnd.sun.star.expand&rdquo; URL references
  54         in the list are expanded using the
  55         com::sun::star::util::theMacroExpander
  56         singleton.</p>
  57
  58         @since OOo 2.3
  59     */
  60     [optional, property] string JavaDriverClassPath;
  61
  62     /** specifies a set of properties to pass to <code>java.lang.System.setProperty</code> before
  63         loading the system's JDBC driver.
  64     */
  65     [optional, property] sequence< ::com::sun::star::beans::NamedValue > SystemProperties;
  66
  67     /** specifies if retrieving of auto generated values should be enabled or not.
  68         If `TRUE` than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not.
  69     */
  70     [optional, property] boolean IsAutoRetrievingEnabled;
  71
  72     /** specifies the statement which should be executed
  73         when asking an "INSERT" statement for the XGeneratedResultSet (future concept) interface.
  74     */
  75     [optional, property] string AutoRetrievingStatement;
  76
  77     /** specifies how the type info returned by com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo() will be modified.
  78         <p>The sequence contains an even amount of string values. Each pair describes
  79         what should be searched for and what should be replaced if found.
  80         <br>
  81         The syntax is:
  82         <p>
  83             <ul>
  84             <li>COLUMN(2) = -5</li>
  85             <li>COLUMN(6) = PRECISION</li>
  86             </ul>
  87         </p>
  88         COLUMN(X) defines the column which will be compared and the column which will be replaced. In the example above column 2 will be compared
  89         with the value -5. If this is true than column 6 will now return the value PRECISION.
  90         </p>
  91     */
  92     [optional, property] sequence< any > TypeInfoSettings;
  93 };
  94
  95
  96 }; }; }; };
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */