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