offapi/com/sun/star/sdbcx/XRename.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_XRename_idl__
  29 #define __com_sun_star_sdbcx_XRename_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/container/ElementExistException.idl>
  36
  37  module com {  module sun {  module star {  module sdbcx {
  38
  39 /** supports the renaming of definition objects.
  40     <br/>
  41
  42     This is a very desirable feature which is not supported by all databases. There is no
  43     standard SQL statement provided for this feature.
  44  */
  45 published interface XRename: com::sun::star::uno::XInterface
  46 {
  47
  48     /** is intended to alter the name of a object.
  49         @param newName
  50             the new name
  51         @throws com::sun::star::sdbc::SQLException
  52             if a database access error occurs.
  53      */
  54     void rename([in]string newName)
  55         raises (com::sun::star::sdbc::SQLException,
  56                 com::sun::star::container::ElementExistException);
  57 };
  58
  59 //=============================================================================
  60
  61 }; }; }; };
  62
  63 /*===========================================================================
  64 ===========================================================================*/
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */