offapi/com/sun/star/sdbcx/XRename.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 #ifndef __com_sun_star_sdbcx_XRename_idl__
  20 #define __com_sun_star_sdbcx_XRename_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/sdbc/SQLException.idl>
  25
  26 #include <com/sun/star/container/ElementExistException.idl>
  27
  28  module com {  module sun {  module star {  module sdbcx {
  29
  30 /** supports the renaming of definition objects.
  31     <br/>
  32
  33     This is a very desirable feature which is not supported by all databases. There is no
  34     standard SQL statement provided for this feature.
  35  */
  36 published interface XRename: com::sun::star::uno::XInterface
  37 {
  38
  39     /** is intended to alter the name of a object.
  40         @param newName
  41             the new name
  42         @throws com::sun::star::sdbc::SQLException
  43             if a database access error occurs.
  44      */
  45     void rename([in]string newName)
  46         raises (com::sun::star::sdbc::SQLException,
  47                 com::sun::star::container::ElementExistException);
  48 };
  49
  50
  51 }; }; }; };
  52
  53 /*===========================================================================
  54 ===========================================================================*/
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */