offapi/com/sun/star/sdbcx/XDrop.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 #ifndef __com_sun_star_sdbcx_XDrop_idl__
  20 #define __com_sun_star_sdbcx_XDrop_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/sdbc/SQLException.idl>
  25
  26 #include <com/sun/star/container/NoSuchElementException.idl>
  27
  28 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  29
  30  module com {  module sun {  module star {  module sdbcx {
  31
  32 /** provides methods to remove an element of its container and to drop it from
  33     the related database.
  34  */
  35 published interface XDrop: com::sun::star::uno::XInterface
  36 {
  37
  38     /** drops an object of the related container identified by its name.
  39         @param elementName
  40             the name of the element to be dropped
  41         @throws com::sun::star::sdbc::SQLException
  42             if a database access error occurs.
  43      */
  44     void dropByName([in]string elementName) raises
  45     (com::sun::star::sdbc::SQLException,
  46         com::sun::star::container::NoSuchElementException);
  47
  48     /** drops an object of the related container identified by its position.
  49         @param index
  50             the position of the element to be dropped
  51         @throws com::sun::star::sdbc::SQLException
  52             if a database access error occurs.
  53      */
  54     void dropByIndex([in]long index) raises (com::sun::star::sdbc::SQLException,
  55         com::sun::star::lang::IndexOutOfBoundsException);
  56 };
  57
  58
  59 }; }; }; };
  60
  61 /*===========================================================================
  62 ===========================================================================*/
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */