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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbcx_XDeleteRows_idl__
  29 #define __com_sun_star_sdbcx_XDeleteRows_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33 #include <com/sun/star/sdbc/SQLException.idl>
  34
  35  module com {  module sun {  module star {  module sdbcx {
  36
  37
  38 /** provides for the deletion of more than one row at a time.
  39  */
  40 published interface XDeleteRows: com::sun::star::uno::XInterface
  41 {
  42
  43     /** deletes one or more rows identified by their bookmarks.
  44              @param rows
  45                 list of bookmarks identifying the rows.
  46              @returns
  47                 an array of update counts containing one element for each
  48                  row. The array is ordered according to the order in
  49                 which bookmarks were given.
  50              @throws com::sun::star::sdbc::SQLException
  51                 if a fatal error occurs, for instance, the connection gets lost if bookmarks
  52                 are used which do not belong to the according result set.
  53      */
  54     sequence<long> deleteRows([in]sequence<any> rows)
  55         raises (com::sun::star::sdbc::SQLException);
  56 };
  57
  58 //=============================================================================
  59
  60 }; }; }; };
  61
  62 /*===========================================================================
  63 ===========================================================================*/
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */