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_ODBCConnectionProperties_idl__ 24#define __com_sun_star_sdbc_ODBCConnectionProperties_idl__ 25 26#ifndef __com_sun_star_sdbc_ConnectionProperties_idl__ 27#include <com/sun/star/sdbc/ConnectionProperties.idl> 28#endif 29 30module com { module sun { module star { module sdbc { 31 32/** represents the properties for a ODBC connection (session) with a specific 33 database. These properties can be used when calling the method 34 <member scope="com::sun::star::sdbc">XDriver::connect()</member> or 35 <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. 36 37 <p> 38 The properties for a connection contain additonal information about how to connect to a database and 39 how to control the behavior of the resulting connection should be. 40 41 </p> 42 @see com::sun::star::sdbc::XDriver 43 @see com::sun::star::sdbc::XDriverManager 44 @see com::sun::star::sdbc::ConnectionProperties 45 */ 46service ODBCConnectionProperties 47{ 48 service com::sun::star::sdbc::ConnectionProperties; 49 /** should the parameter '?' in prepared statement be substituated with an distinct name 50 */ 51 [optional, property] boolean ParameterNameSubstitution; 52 53 /** the Timeout after which time a timeout should happen 54 */ 55 [optional, property] long Timeout; 56 57 /** Silent - should the connection be silent. No user interaction while creating the connection. 58 */ 59 [optional, property] boolean Silent; 60 61 /** should the driver should support a catalog. 62 */ 63 [optional, property] boolean UseCatalog; 64 65 /** specifies the encoding to use to translate the backend data 66 67 <p>See the <a href="http://www.iana.org/assignments/character-sets">IANA character set list</a> 68 for a list of valid values.</p> 69 */ 70 [optional, property] string CharSet; 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 83//============================================================================= 84 85}; }; }; }; 86 87/*=========================================================================== 88 89===========================================================================*/ 90#endif 91