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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20  module com {  module sun {  module star {  module sdbc {
  21
  22  published interface XDriver;
  23
  24
  25 /** is the service that every driver class must implement.
  26
  27     <p>
  28     Each driver should supply a service that implements
  29     the Driver interface.
  30
  31     </p>
  32     <p>
  33     The DriverManager will try to load as many drivers as it can
  34     find and then for any given connection request, it will ask each
  35     driver in turn to try to connect to the target URL.
  36
  37     </p>
  38     <p>
  39     It is strongly recommended that each Driver object should be
  40     small and standalone so that the Driver object can be loaded and
  41     queried without bringing in vast quantities of supporting code.
  42
  43     </p>
  44     <p>
  45     Each driver should be a one instance service.
  46
  47     </p>
  48     @see com::sun::star::sdbc::XDriverManager
  49     @see com::sun::star::sdbc::XConnection
  50  */
  51 published service Driver
  52 {
  53
  54     /** is the main interface to access a database driver.
  55      */
  56     interface XDriver;
  57 };
  58
  59
  60 }; }; }; };
  61
  62 /*===========================================================================
  63 ===========================================================================*/
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */