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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sdbc_XDriverManager_idl__
  28 #define __com_sun_star_sdbc_XDriverManager_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_beans_PropertyValue_idl__
  35 #include <com/sun/star/beans/PropertyValue.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sdbc_SQLException_idl__
  39 #include <com/sun/star/sdbc/SQLException.idl>
  40 #endif
  41
  42  module com {  module sun {  module star {  module sdbc {
  43
  44  published interface XConnection;
  45  published interface XDriver;
  46
  47
  48 /** is the basic interface for managing a set of SDBC drivers.
  49
  50
  51
  52     <p>
  53     When the method
  54     <member scope="com::sun::star::sdbc">XDriverManager::getConnection()</member>
  55     is called,
  56     the DriverManager will attempt to
  57     locate a suitable driver.
  58
  59     </p>
  60     @see com::sun::star::sdbc::XDriver
  61      @see com::sun::star::sdbc::XConnection
  62  */
  63 published interface XDriverManager: com::sun::star::uno::XInterface
  64 {
  65     //-------------------------------------------------------------------------
  66
  67     /** attempts to establish a connection to the given database URL.
  68         The DriverManager attempts to select an appropriate driver from
  69         the set of registered JDBC/SDBC drivers.
  70         @param url
  71             a database url of the form  sdbc:subprotocol:subname
  72         @returns
  73             the Connection object
  74         @throws SQLException
  75             if a database access error occurs.
  76      */
  77     XConnection getConnection([in]string url)
  78         raises (SQLException);
  79     //-------------------------------------------------------------------------
  80
  81     /** attempts to establish a connection to the given database URL.
  82         The DriverManager attempts to select an appropriate driver from
  83         the set of registered JDBC/SDBC drivers.
  84         @param url
  85             a database url of the form  sdbc:subprotocol:subname
  86         @param info
  87             a list of arbitrary string tag/value pairs as connection arguments;
  88             normally at least a "user" and "password" property should be included
  89             @see com::sun::star::sdbc::ConnectionProperties
  90         @returns
  91             the Connection object
  92         @throws SQLException
  93             if a database access error occurs.
  94      */
  95     XConnection getConnectionWithInfo([in]string url,
  96             [in]sequence<com::sun::star::beans::PropertyValue> info)
  97         raises (SQLException);
  98     //-------------------------------------------------------------------------
  99
 100     /** sets the maximum time in seconds that a driver will wait
 101         while attempting to connect to a database.
 102         @param seconds
 103             the login time limit in seconds
 104
 105         @throws SQLException
 106             if a database access error occurs.
 107      */
 108     void setLoginTimeout([in]long seconds);
 109     //-------------------------------------------------------------------------
 110
 111     /** gets the maximum time in seconds that a driver can wait
 112         when attempting to login to a database.
 113         @returns
 114             the driver login time limit in seconds
 115
 116         @throws SQLException
 117             if a database access error occurs.
 118      */
 119     long getLoginTimeout();
 120 };
 121
 122 //=============================================================================
 123
 124 }; }; }; };
 125
 126 #endif