offapi/com/sun/star/sdbc/DriverManager.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: DriverManager.idl,v $
  10  * $Revision: 1.10 $
  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_DriverManager_idl__
  31 #define __com_sun_star_sdbc_DriverManager_idl__
  32
  33 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  34 #include <com/sun/star/container/XEnumerationAccess.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdbc {
  38
  39  published interface XConnection;
  40  published interface XDriver;
  41  published interface XDriverManager;
  42
  43
  44 /** is the basic service for managing a set of SDBC drivers.
  45
  46
  47     <p>
  48     As part of its initialization, the DriverManager service will
  49     attempt to load the registered drivers.
  50
  51     </p>
  52     <p>
  53     When the method <code>getConnection</code> is called,
  54     the DriverManager will attempt to
  55     locate a suitable driver.
  56
  57     </p>
  58     @see com::sun::star::sdbc::XDriver
  59     @see com::sun::star::sdbc::XConnection
  60  */
  61 published service DriverManager
  62 {
  63
  64     /** is the basic interface for establishing database connections.
  65      */
  66     interface XDriverManager;
  67
  68     /** creates an enumeration on all installed / registered drivers.
  69      */
  70     interface com::sun::star::container::XEnumerationAccess;
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 /*===========================================================================
  78 ===========================================================================*/
  79 #endif