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

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