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
  20  module com {  module sun {  module star {  module sdbc {
  21
  22  published interface XConnection;
  23  published interface XDriver;
  24
  25
  26 /** is the basic interface for managing a set of SDBC drivers.
  27
  28
  29
  30     <p>
  31     When the method
  32     com::sun::star::sdbc::XDriverManager::getConnection()
  33     is called,
  34     the DriverManager will attempt to
  35     locate a suitable driver.
  36
  37     </p>
  38     @see com::sun::star::sdbc::XDriver
  39      @see com::sun::star::sdbc::XConnection
  40  */
  41 published interface XDriverManager: com::sun::star::uno::XInterface
  42 {
  43
  44     /** attempts to establish a connection to the given database URL.
  45         The DriverManager attempts to select an appropriate driver from
  46         the set of registered JDBC/SDBC drivers.
  47         @param url
  48             a database url of the form  sdbc:subprotocol:subname
  49         @returns
  50             the Connection object
  51         @throws SQLException
  52             if a database access error occurs.
  53      */
  54     XConnection getConnection([in]string url)
  55         raises (SQLException);
  56
  57     /** attempts to establish a connection to the given database URL.
  58         The DriverManager attempts to select an appropriate driver from
  59         the set of registered JDBC/SDBC drivers.
  60         @param url
  61             a database url of the form  sdbc:subprotocol:subname
  62         @param info
  63             a list of arbitrary string tag/value pairs as connection arguments;
  64             normally at least a "user" and "password" property should be included
  65             @see com::sun::star::sdbc::ConnectionProperties
  66         @returns
  67             the Connection object
  68         @throws SQLException
  69             if a database access error occurs.
  70      */
  71     XConnection getConnectionWithInfo([in]string url,
  72             [in]sequence<com::sun::star::beans::PropertyValue> info)
  73         raises (SQLException);
  74
  75     /** sets the maximum time in seconds that a driver will wait
  76         while attempting to connect to a database.
  77         @param seconds
  78             the login time limit in seconds
  79
  80         @throws SQLException
  81             if a database access error occurs.
  82      */
  83     void setLoginTimeout([in]long seconds);
  84
  85     /** gets the maximum time in seconds that a driver can wait
  86         when attempting to login to a database.
  87         @returns
  88             the driver login time limit in seconds
  89
  90         @throws SQLException
  91             if a database access error occurs.
  92      */
  93     long getLoginTimeout();
  94 };
  95
  96
  97 }; }; }; };
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */