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