offapi/com/sun/star/sdbcx/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.12 $
  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_sdbcx_Driver_idl__
  31 #define __com_sun_star_sdbcx_Driver_idl__
  32
  33 #ifndef __com_sun_star_sdbc_Driver_idl__
  34 #include <com/sun/star/sdbc/Driver.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdbcx {
  38
  39  published interface XDataDefinitionSupplier;
  40  published interface XCreateCatalog;
  41  published interface XDropCatalog;
  42
  43
  44 /** extends the service
  45     <type scope="com::sun::star::sdbc">Driver</type>
  46     by beans for data definition.
  47 <p>
  48     This service is optional for each driver. Its purpose is to define
  49     a common way for database definition, as the DDL differs between most DBMS.
  50 </p>
  51 <p>
  52     Definition and deletion of database catalogs can't be defined in a common
  53     manner for DBMS, but it should be possible to hide much of the complexity
  54     of creation and deletion of catalogs. Each driver could provide methods to
  55     cover these tasks.
  56 </p>
  57  */
  58 published service Driver
  59 {
  60     service com::sun::star::sdbc::Driver;
  61
  62     /** used to get access to the catalog.
  63         @see Catalog
  64     */
  65     interface XDataDefinitionSupplier;
  66
  67
  68     /** is optional for implementation.
  69      */
  70     [optional] interface XCreateCatalog;
  71
  72     /** is optional for implementation.
  73      */
  74     [optional] interface XDropCatalog;
  75 };
  76
  77 //=============================================================================
  78
  79 }; }; }; };
  80
  81 #endif