offapi/com/sun/star/sdbcx/XDrop.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sdbcx_XDrop_idl__
  28 #define __com_sun_star_sdbcx_XDrop_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_sdbc_SQLException_idl__
  35 #include <com/sun/star/sdbc/SQLException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  39 #include <com/sun/star/container/NoSuchElementException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
  43 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  44 #endif
  45
  46  module com {  module sun {  module star {  module sdbcx {
  47
  48 /** provides methods to remove an element of its container and to drop it from
  49     the related database.
  50  */
  51 published interface XDrop: com::sun::star::uno::XInterface
  52 {
  53
  54     /** drops an object of the related container identified by its name.
  55         @param elementName
  56             the name of the element to be dropped
  57         @throws com::sun::star::sdbc::SQLException
  58             if a database access error occurs.
  59      */
  60     void dropByName([in]string elementName) raises
  61     (com::sun::star::sdbc::SQLException,
  62         com::sun::star::container::NoSuchElementException);
  63     //-------------------------------------------------------------------------
  64
  65     /** drops an object of the related container identified by its position.
  66         @param index
  67             the position of the element to be dropped
  68         @throws com::sun::star::sdbc::SQLException
  69             if a database access error occurs.
  70      */
  71     void dropByIndex([in]long index) raises (com::sun::star::sdbc::SQLException,
  72         com::sun::star::lang::IndexOutOfBoundsException);
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 /*===========================================================================
  80 ===========================================================================*/
  81 #endif