offapi/com/sun/star/sdbc/Driver.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: Driver.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_Driver_idl__
  31 #define __com_sun_star_sdbc_Driver_idl__
  32
  33  module com {  module sun {  module star {  module sdbc {
  34
  35  published interface XDriver;
  36
  37
  38 /** is the service that every driver class must implement.
  39
  40     <p>
  41     Each driver should supply a service that implements
  42     the Driver interface.
  43
  44     </p>
  45     <p>
  46     The DriverManager will try to load as many drivers as it can
  47     find and then for any given connection request, it will ask each
  48     driver in turn to try to connect to the target URL.
  49
  50     </p>
  51     <p>
  52     It is strongly recommended that each Driver object should be
  53     small and standalone so that the Driver object can be loaded and
  54     queried without bringing in vast quantities of supporting code.
  55
  56     </p>
  57     <p>
  58     Each driver should be a one instance service.
  59
  60     </p>
  61     @see com::sun::star::sdbc::XDriverManager
  62     @see com::sun::star::sdbc::XConnection
  63  */
  64 published service Driver
  65 {
  66
  67     /** is the main interface to access a database driver.
  68      */
  69     interface XDriver;
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 /*===========================================================================
  77 ===========================================================================*/
  78 #endif