offapi/com/sun/star/sdb/XDatabaseAccess.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: XDatabaseAccess.idl,v $
  10  * $Revision: 1.13 $
  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_sdb_XDatabaseAccess_idl__
  31 #define __com_sun_star_sdb_XDatabaseAccess_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_XDataSource_idl__
  38 #include <com/sun/star/sdbc/XDataSource.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_sdbc_SQLException_idl__
  42 #include <com/sun/star/sdbc/SQLException.idl>
  43 #endif
  44
  45  module com {  module sun {  module star {  module task {
  46  published interface XInteractionHandler;
  47 };};};};
  48
  49 //=============================================================================
  50
  51  module com {  module sun {  module star {  module sdb {
  52
  53  published interface XDatabaseAccessListener;
  54
  55 //=============================================================================
  56
  57 /** is used to connect to a data access bean. A data access bean represents a
  58     database connection and provides additional information related to the connection
  59     such as forms, reports, or queries.
  60  */
  61 published interface XDatabaseAccess: com::sun::star::sdbc::XDataSource
  62 {
  63
  64     /** indicates that connections already exist.
  65         @returns
  66             <TRUE/> if so
  67      */
  68     boolean hasConnections();
  69     //-------------------------------------------------------------------------
  70
  71     /** attempts to establish a database connection, that can not be shared with
  72         other components. This should be used for transaction processing.
  73         @param user
  74             the user name
  75         @param password
  76             the password
  77         @returns
  78             an isolated connection object
  79         @throws com::sun::star::sdbc::SQLException
  80             if a database access error occurs.
  81         @see com::sun::star::sdbc::XConnection
  82      */
  83     com::sun::star::sdbc::XConnection getIsolatedConnection([in]string user, [in]string password)
  84       raises (com::sun::star::sdbc::SQLException);
  85     //-------------------------------------------------------------------------
  86
  87     /** closes the all connections to database. This request could be aborted by
  88         listeners of the component.
  89         @throws com::sun::star::sdbc::SQLException
  90             if a database access error occurs.
  91      */
  92     boolean suspendConnections() raises (com::sun::star::sdbc::SQLException);
  93     //-------------------------------------------------------------------------
  94
  95     /** adds the specified listener to receive the events "connectionChanged",
  96         "approveConnectionClose", and "connectionClosing".
  97         @param  listener
  98             the listener to append
  99         @see com::sun::star::sdb::XDatabaseAccessListener
 100      */
 101     [oneway] void addDatabaseAccessListener([in]XDatabaseAccessListener listener);
 102     //-------------------------------------------------------------------------
 103
 104     /** removes the specified listener.
 105         @param  listener
 106             the listener to append
 107         @see com::sun::star::sdb::XDatabaseAccessListener
 108      */
 109     [oneway] void removeDatabaseAccessListener(
 110             [in]XDatabaseAccessListener listener);
 111 };
 112
 113 //=============================================================================
 114
 115 }; }; }; };
 116
 117 /*=============================================================================
 118
 119 =============================================================================*/
 120 #endif