offapi/com/sun/star/sdbc/XDataSource.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
  24
  25 /** is used for establishing connections via a factory which is identified
  26     by its name. A DataSource object is typically registered by a naming service
  27     provider.
  28  */
  29 published interface XDataSource: com::sun::star::uno::XInterface
  30 {
  31
  32     /** attempts to establish a database connection.
  33         @param user
  34             the user name
  35         @param password
  36             the password
  37         @returns
  38             the connection object
  39         @throws SQLException
  40             if a database access error occurs.
  41      */
  42     XConnection getConnection([in]string user, [in]string password)
  43         raises (SQLException);
  44
  45     /** sets the maximum time in seconds that this data source will wait
  46         while attempting to connect to a database.
  47
  48
  49         <p>
  50         A value of zero specifies that the timeout is the default system
  51         timeout if there is one; otherwise, it specifies that there is no timeout.
  52         When a DataSource object is created the login timeout is initially zero.
  53         </p>
  54         @param seconds
  55             the login time limit in seconds
  56         @throws SQLException
  57             if a database access error occurs.
  58      */
  59     void setLoginTimeout([in]long seconds)
  60          raises (SQLException);
  61
  62     /** gets the maximum time in seconds that this data source can wait
  63         while attempting to connect to a database.
  64
  65
  66         <p>
  67         A value of zero means that the timeout is the default system timeout
  68         if there is one; otherwise, it means that there is no timeout. When a
  69         DataSource object is created the login timeout is initially zero.
  70         </p>
  71         @returns
  72             the login time limit in seconds
  73         @throws SQLException
  74             if a database access error occurs.
  75      */
  76     long getLoginTimeout() raises (SQLException);
  77 };
  78
  79
  80 }; }; }; };
  81
  82 /*===========================================================================
  83 ===========================================================================*/
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */