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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sdbc_XDriverManager_idl__
  20 #define __com_sun_star_sdbc_XDriverManager_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/PropertyValue.idl>
  25
  26 #include <com/sun/star/sdbc/SQLException.idl>
  27
  28  module com {  module sun {  module star {  module sdbc {
  29
  30  published interface XConnection;
  31  published interface XDriver;
  32
  33
  34 /** is the basic interface for managing a set of SDBC drivers.
  35
  36
  37
  38     <p>
  39     When the method
  40     com::sun::star::sdbc::XDriverManager::getConnection()
  41     is called,
  42     the DriverManager will attempt to
  43     locate a suitable driver.
  44
  45     </p>
  46     @see com::sun::star::sdbc::XDriver
  47      @see com::sun::star::sdbc::XConnection
  48  */
  49 published interface XDriverManager: com::sun::star::uno::XInterface
  50 {
  51
  52     /** attempts to establish a connection to the given database URL.
  53         The DriverManager attempts to select an appropriate driver from
  54         the set of registered JDBC/SDBC drivers.
  55         @param url
  56             a database url of the form  sdbc:subprotocol:subname
  57         @returns
  58             the Connection object
  59         @throws SQLException
  60             if a database access error occurs.
  61      */
  62     XConnection getConnection([in]string url)
  63         raises (SQLException);
  64
  65     /** attempts to establish a connection to the given database URL.
  66         The DriverManager attempts to select an appropriate driver from
  67         the set of registered JDBC/SDBC drivers.
  68         @param url
  69             a database url of the form  sdbc:subprotocol:subname
  70         @param info
  71             a list of arbitrary string tag/value pairs as connection arguments;
  72             normally at least a "user" and "password" property should be included
  73             @see com::sun::star::sdbc::ConnectionProperties
  74         @returns
  75             the Connection object
  76         @throws SQLException
  77             if a database access error occurs.
  78      */
  79     XConnection getConnectionWithInfo([in]string url,
  80             [in]sequence<com::sun::star::beans::PropertyValue> info)
  81         raises (SQLException);
  82
  83     /** sets the maximum time in seconds that a driver will wait
  84         while attempting to connect to a database.
  85         @param seconds
  86             the login time limit in seconds
  87
  88         @throws SQLException
  89             if a database access error occurs.
  90      */
  91     void setLoginTimeout([in]long seconds);
  92
  93     /** gets the maximum time in seconds that a driver can wait
  94         when attempting to login to a database.
  95         @returns
  96             the driver login time limit in seconds
  97
  98         @throws SQLException
  99             if a database access error occurs.
 100      */
 101     long getLoginTimeout();
 102 };
 103
 104
 105 }; }; }; };
 106
 107 #endif
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */