offapi/com/sun/star/sdbcx/XAlterTable.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: XAlterTable.idl,v $
  10  * $Revision: 1.12 $
  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_XAlterTable_idl__
  31 #define __com_sun_star_sdbcx_XAlterTable_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_container_NoSuchElementException_idl__
  38 #include <com/sun/star/container/NoSuchElementException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
  42 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  43 #endif
  44
  45  module com {  module sun {  module star {  module beans {
  46  published interface XPropertySet;
  47 };};};};
  48
  49 #ifndef __com_sun_star_sdbc_SQLException_idl__
  50 #include <com/sun/star/sdbc/SQLException.idl>
  51 #endif
  52
  53  module com {  module sun {  module star {  module sdbcx {
  54
  55 /** is used for creating and appending new objects to a specific container.
  56  */
  57 published interface XAlterTable: com::sun::star::uno::XInterface
  58 {
  59
  60     /** is intended to alter an existing column identified by its name.
  61         This operation must be atomic, in that it is done in one step.s
  62
  63         @param colName
  64             the column name which to alter
  65         @param descriptor
  66             the new descriptor for the new column
  67         @throws com::sun::star::sdbc::SQLException
  68             if a database access error occurs.
  69     */
  70     void alterColumnByName([in]string colName,
  71         [in]com::sun::star::beans::XPropertySet descriptor)
  72         raises (com::sun::star::sdbc::SQLException,
  73                 com::sun::star::container::NoSuchElementException);
  74     //-------------------------------------------------------------------------
  75
  76     /** is intended to alter an existing column identified by its position.
  77         This operation must be atomic, in that it is done in one step.s
  78
  79         @param index
  80             the position of the column to alter
  81         @param descriptor
  82             the new descriptor for the new column
  83         @throws com::sun::star::sdbc::SQLException
  84             if a database access error occurs.
  85         @throws com::sun::star::lang::IndexOutOfBoundsException
  86             if the given index does not denote an existing column.
  87     */
  88     void alterColumnByIndex([in]long index,
  89         [in]com::sun::star::beans::XPropertySet descriptor) raises
  90         (com::sun::star::sdbc::SQLException,
  91           com::sun::star::lang::IndexOutOfBoundsException);
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; };
  97
  98 /*===========================================================================
  99 ===========================================================================*/
 100 #endif