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