offapi/com/sun/star/sdb/tools/XTableRename.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 #ifndef __com_sun_star_sdb_tools_XTableRename_idl__
  21 #define __com_sun_star_sdb_tools_XTableRename_idl__
  22
  23 #include <com/sun/star/sdbc/SQLException.idl>
  24 #include <com/sun/star/sdb/tools/XConnectionSupplier.idl>
  25 #include <com/sun/star/lang/XInitialization.idl>
  26 #include <com/sun/star/beans/XPropertySet.idl>
  27
  28 module com {  module sun {  module star {  module sdb { module tools {
  29
  30 /** allows to rename table.
  31
  32     @see com::sun::star::sdb::DataSource::Settings
  33
  34     @since OOo 3.3
  35 */
  36 interface XTableRename
  37 {
  38     interface XConnectionSupplier;
  39
  40     /** rename the given table to the new name
  41
  42         @param table
  43             the table to be renamed
  44         @param newName
  45             the new name of the table
  46         @throws com::sun::star::sdbc::SQLException
  47     */
  48     void  rename( [in] com::sun::star::beans::XPropertySet table, [in] string newName)
  49         raises ( com::sun::star::sdbc::SQLException );
  50
  51
  52 };
  53 }; }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */