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