offapi/com/sun/star/sdbcx/XDropCatalog.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbcx_XDropCatalog_idl__
  29 #define __com_sun_star_sdbcx_XDropCatalog_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33 #include <com/sun/star/sdbc/SQLException.idl>
  34
  35 #include <com/sun/star/beans/PropertyValue.idl>
  36
  37 #include <com/sun/star/container/NoSuchElementException.idl>
  38
  39  module com {  module sun {  module star {  module sdbcx {
  40
  41
  42 /** may be implemented to hide the complexity of dropping a database catalog. Could
  43     normally be used only in offline mode, no connection on the database. This
  44     should be checked by the driver.
  45  */
  46 published interface XDropCatalog: com::sun::star::uno::XInterface
  47 {
  48
  49     /** drops a catalog identified by its name.
  50         @param catalogName
  51             the catalog name
  52         @param info
  53             driver specific information
  54         @throws com::sun::star::sdbc::SQLException
  55             if a database access error occurs.
  56      */
  57     void dropCatalog([in]string catalogName,
  58                      [in]sequence<com::sun::star::beans::PropertyValue> info)
  59         raises (com::sun::star::sdbc::SQLException,
  60                 com::sun::star::container::NoSuchElementException);
  61 };
  62
  63 //=============================================================================
  64
  65 }; }; }; };
  66
  67 /*===========================================================================
  68 ===========================================================================*/
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */