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