offapi/com/sun/star/sdb/tools/XIndexAlteration.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 #ifndef __com_sun_star_sdb_tools_XIndexAlteration_idl__
  21 #define __com_sun_star_sdb_tools_XIndexAlteration_idl__
  22
  23 #include <com/sun/star/sdbc/SQLException.idl>
  24 #include <com/sun/star/sdb/tools/XConnectionSupplier.idl>
  25 #include <com/sun/star/lang/XInitialization.idl>
  26 #include <com/sun/star/beans/XPropertySet.idl>
  27
  28 module com {  module sun {  module star {  module sdb { module tools {
  29
  30 /** allows to alter the indexes of a table.
  31
  32     @see com::sun::star::sdb::DataSource::Settings
  33     @see com::sun::star::sdbcx::XAppend
  34     @see com::sun::star::sdbcx::XDrop
  35
  36     @since OOo 3.3
  37 */
  38 interface XIndexAlteration
  39 {
  40     interface XConnectionSupplier;
  41
  42     /** drops an object of the related container identified by its name.
  43         @param table
  44             the table to be altered
  45         @param index
  46             the name of the column to be dropped
  47         @throws com::sun::star::sdbc::SQLException
  48             if a database access error occurs.
  49      */
  50     void dropIndex([in] com::sun::star::beans::XPropertySet table,[in] string index)
  51         raises ( com::sun::star::sdbc::SQLException);
  52
  53     /** creates a new object using the given descriptor and appends it
  54         to the related container.
  55         <b>
  56         Note:
  57         </b>
  58         The descriptor will not be changed and can be used again to append another object.
  59         @param table
  60             the table to be altered
  61         @param descriptor
  62             the descriptor which should be serve to append a new object
  63         @throws com::sun::star::sdbc::SQLException
  64             if a database access error occurs.
  65      */
  66     void addIndex([in] com::sun::star::beans::XPropertySet table,[in]com::sun::star::beans::XPropertySet descriptor)
  67         raises (com::sun::star::sdbc::SQLException);
  68
  69
  70 };
  71 }; }; }; }; };
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */