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