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