1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_sdbc_JDBCConnectionProperties_idl__ 24#define __com_sun_star_sdbc_JDBCConnectionProperties_idl__ 25 26#ifndef __com_sun_star_sdbc_ConnectionProperties_idl__ 27#include <com/sun/star/sdbc/ConnectionProperties.idl> 28#endif 29#ifndef __com_sun_star_beans_NamedValue_idl__ 30#include <com/sun/star/beans/NamedValue.idl> 31#endif 32 33module com { module sun { module star { module sdbc { 34 35/** represents the properties for a JDBC connection (session) with a specific 36 database. These properties can be used when calling the method 37 <member scope="com::sun::star::sdbc">XDriver::connect()</member> or 38 <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. 39 40 <p> 41 The properties for a connection contain additonal information about how to connect to a database and 42 how to control the behavior of the resulting connection should be. 43 44 </p> 45 @see com::sun::star::sdbc::XDriver 46 @see com::sun::star::sdbc::XDriverManager 47 @see com::sun::star::sdbc::ConnectionProperties 48 */ 49service JDBCConnectionProperties 50{ 51 service com::sun::star::sdbc::ConnectionProperties; 52 53 /** which jdbc driver class should be loaded to create the connection. 54 55 @see com::sun::star::sdbc::JDBCConnectionProperties::JavaDriverClassPath 56 */ 57 [optional, property] string JavaDriverClass; 58 59 /** an optional class path to locate the <member 60 scope="com::sun::star::sdbc">JDBCConnectionProperties::JavaDriverClass 61 </member>. 62 63 <p>The class path is a list of zero or more internal (see the 64 <type scope="com::sun::star::uri">ExternalUriReferenceTranslator</type> 65 service) URI references, where any space characters 66 (<code>U+0020</code>) are ignored (and, in particular, separate adjacent 67 URI references). Any “vnd.sun.star.expand” URL references 68 in the list are expanded using the 69 <type scope="com::sun::star::util">theMacroExpander</type> 70 singleton.</p> 71 72 @since OpenOffice 2.3 73 */ 74 [optional, property] string JavaDriverClassPath; 75 76 /** specifies a set of properties to pass to <code>java.lang.System.setProperty</code> before 77 loading the system's JDBC driver. 78 */ 79 [optional, property] sequence< ::com::sun::star::beans::NamedValue > SystemProperties; 80 81 /** specifies if retrieving of auto generated values should be enabled or not. 82 If <TRUE/> than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not. 83 */ 84 [optional, property] boolean IsAutoRetrievingEnabled; 85 86 /** specifies the statement which should be executed 87 when asking an "INSERT" statement for the XGeneratedResultSet (future concept) interface. 88 */ 89 [optional, property] string AutoRetrievingStatement; 90 91 /** specifies how the type info returned by <member scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member> will be modified. 92 <p>The sequence contains an even amount of string values. Each pair describes 93 <li>what should be searched for and </li> 94 <li>what should be replaced if found.</li> 95 <br> 96 The syntax is: 97 <p> 98 <li>COLUMN(2) = -5</li> 99 <li>COLUMN(6) = PRECISION</li> 100 </p> 101 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 102 with the value -5. If this is true than column 6 will now return the value PRECISION. 103 </p> 104 */ 105 [optional, property] sequence< any > TypeInfoSettings; 106}; 107 108//============================================================================= 109 110}; }; }; }; 111 112/*=========================================================================== 113 114===========================================================================*/ 115#endif 116