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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: JDBCConnectionProperties.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbc_JDBCConnectionProperties_idl__
  31 #define __com_sun_star_sdbc_JDBCConnectionProperties_idl__
  32
  33 #ifndef __com_sun_star_sdbc_ConnectionProperties_idl__
  34 #include <com/sun/star/sdbc/ConnectionProperties.idl>
  35 #endif
  36 #ifndef __com_sun_star_beans_NamedValue_idl__
  37 #include <com/sun/star/beans/NamedValue.idl>
  38 #endif
  39
  40 module com {  module sun {  module star {  module sdbc {
  41
  42 /** represents the properties for a JDBC connection (session) with a specific
  43     database. These properties can be used when calling the method
  44     <member scope="com::sun::star::sdbc">XDriver::connect()</member> or
  45     <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>.
  46
  47     <p>
  48     The properties for a connection contain additonal information about how to connect to a database and
  49     how to control the behavior of the resulting connection should be.
  50
  51     </p>
  52     @see com::sun::star::sdbc::XDriver
  53     @see com::sun::star::sdbc::XDriverManager
  54     @see com::sun::star::sdbc::ConnectionProperties
  55  */
  56 service JDBCConnectionProperties
  57 {
  58     service com::sun::star::sdbc::ConnectionProperties;
  59
  60     /** which jdbc driver class should be loaded to create the connection.
  61
  62         @see com::sun::star::sdbc::JDBCConnectionProperties::JavaDriverClassPath
  63     */
  64     [optional, property] string JavaDriverClass;
  65
  66     /** an optional class path to locate the <member
  67         scope="com::sun::star::sdbc">JDBCConnectionProperties::JavaDriverClass
  68         </member>.
  69
  70         <p>The class path is a list of zero or more internal (see the
  71         <type scope="com::sun::star::uri">ExternalUriReferenceTranslator</type>
  72         service) URI references, where any space characters
  73         (<code>U+0020</code>) are ignored (and, in particular, separate adjacent
  74         URI references).  Any &ldquo;vnd.sun.star.expand&rdquo; URL references
  75         in the list are expanded using the
  76         <type scope="com::sun::star::util">theMacroExpander</type>
  77         singleton.</p>
  78
  79         @since OOo 2.3
  80     */
  81     [optional, property] string JavaDriverClassPath;
  82
  83     /** specifies a set of properties to pass to <code>java.lang.System.setProperty</code> before
  84         loading the system's JDBC driver.
  85     */
  86     [optional, property] sequence< ::com::sun::star::beans::NamedValue > SystemProperties;
  87
  88     /** specifies if retrieving of auto generated values should be enabled or not.
  89         If <TRUE/> than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not.
  90     */
  91     [optional, property] boolean IsAutoRetrievingEnabled;
  92
  93     /** specifies the statement which should be executed
  94         when asking an "INSERT" statement for the XGeneratedResultSet (future concept) interface.
  95     */
  96     [optional, property] string AutoRetrievingStatement;
  97
  98     /** specifies how the type info returned by <member scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member> will be modified.
  99         <p>The sequence contains an even amount of string values. Each pair describes
 100         <li>what should be searched for and </li>
 101         <li>what should be replaced if found.</li>
 102         <br>
 103         The syntax is:
 104         <p>
 105             <li>COLUMN(2) = -5</li>
 106             <li>COLUMN(6) = PRECISION</li>
 107         </p>
 108         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
 109         with the value -5. If this is true than column 6 will now return the value PRECISION.
 110         </p>
 111     */
 112     [optional, property] sequence< any > TypeInfoSettings;
 113 };
 114
 115 //=============================================================================
 116
 117 }; }; }; };
 118
 119 /*===========================================================================
 120
 121 ===========================================================================*/
 122 #endif