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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDataSource.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbc_XDataSource_idl__
  31 #define __com_sun_star_sdbc_XDataSource_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_sdbc_SQLException_idl__
  38 #include <com/sun/star/sdbc/SQLException.idl>
  39 #endif
  40
  41  module com {  module sun {  module star {  module sdbc {
  42
  43  published interface XConnection;
  44
  45
  46 /** is used for establishing connections via a factory which is identified
  47     by its name. A DataSource object is typically registered by a naming service
  48     provider.
  49  */
  50 published interface XDataSource: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** attempts to establish a database connection.
  55         @param user
  56             the user name
  57         @param password
  58             the password
  59         @returns
  60             the connection object
  61         @throws SQLException
  62             if a database access error occurs.
  63      */
  64     XConnection getConnection([in]string user, [in]string password)
  65         raises (SQLException);
  66     //-------------------------------------------------------------------------
  67
  68     /** sets the maximum time in seconds that this data source will wait
  69         while attempting to connect to a database.
  70
  71
  72         <p>
  73         A value of zero specifies that the timeout is the default system
  74         timeout if there is one; otherwise, it specifies that there is no timeout.
  75         When a DataSource object is created the login timeout is initially zero.
  76         </p>
  77         @param seconds
  78             the login time limit in seconds
  79         @throws SQLException
  80             if a database access error occurs.
  81      */
  82     void setLoginTimeout([in]long seconds)
  83          raises (SQLException);
  84     //-------------------------------------------------------------------------
  85
  86     /** gets the maximum time in seconds that this data source can wait
  87         while attempting to connect to a database.
  88
  89
  90         <p>
  91         A value of zero means that the timeout is the default system timeout
  92         if there is one; otherwise, it means that there is no timeout. When a
  93         DataSource object is created the login timeout is initially zero.
  94         </p>
  95         @returns
  96             the login time limit in seconds
  97         @throws SQLException
  98             if a database access error occurs.
  99      */
 100     long getLoginTimeout() raises (SQLException);
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; };
 106
 107 /*===========================================================================
 108 ===========================================================================*/
 109 #endif