offapi/com/sun/star/sdb/XDatabaseEnvironment.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: XDatabaseEnvironment.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_sdb_XDatabaseEnvironment_idl__
  31 #define __com_sun_star_sdb_XDatabaseEnvironment_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 #ifndef __com_sun_star_sdbc_XDriverManager_idl__
  42 #include <com/sun/star/sdbc/XDriverManager.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_beans_PropertyValue_idl__
  46 #include <com/sun/star/beans/PropertyValue.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51  module com {  module sun {  module star {  module sdb {
  52
  53  published interface XDatabaseAccess;
  54
  55 //=============================================================================
  56
  57 /** specifies the root of the data access beans. It provides the possiblity
  58     to open a data access bean, which contains tables, queries, forms, and
  59     report documents, or to open a connection to a database.
  60
  61     @deprecated
  62  */
  63 published interface XDatabaseEnvironment: com::sun::star::sdbc::XDriverManager
  64 {
  65     //-------------------------------------------------------------------------
  66
  67     /** returns an existing DatabaseAccess bean specified by it's URL.
  68
  69
  70         <p>Database Access beans are always shared, so if there's a second request
  71         for the same bean, the same instance of the bean will be returned, if it is still alive.
  72         </p>
  73         @param URL
  74             a database url of the form sdbc:subprotocol:subname
  75         @returns
  76             the database access object for this url
  77      */
  78     XDatabaseAccess getDatabaseAccess([in]string URL)
  79         raises (com::sun::star::sdbc::SQLException);
  80     //-------------------------------------------------------------------------
  81
  82     /** creates a new DatabaseAccess bean specified by it's URL.
  83         @param URL
  84             a database url of the form sdbc:subprotocol:subname
  85         @param title
  86             the title of the database access
  87         @returns
  88             the new created database access object for this url
  89      */
  90     XDatabaseAccess createDatabaseAccess([in]string URL, [in]string title)
  91         raises (com::sun::star::sdbc::SQLException);
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; };
  97
  98 /*=============================================================================
  99
 100 =============================================================================*/
 101 #endif