offapi/com/sun/star/sdbcx/XDeleteRows.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_XDeleteRows_idl__
  20 #define __com_sun_star_sdbcx_XDeleteRows_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/sdbc/SQLException.idl>
  25
  26  module com {  module sun {  module star {  module sdbcx {
  27
  28
  29 /** provides for the deletion of more than one row at a time.
  30  */
  31 published interface XDeleteRows: com::sun::star::uno::XInterface
  32 {
  33
  34     /** deletes one or more rows identified by their bookmarks.
  35              @param rows
  36                 list of bookmarks identifying the rows.
  37              @returns
  38                 an array of update counts containing one element for each
  39                  row. The array is ordered according to the order in
  40                 which bookmarks were given.
  41              @throws com::sun::star::sdbc::SQLException
  42                 if a fatal error occurs, for instance, the connection gets lost if bookmarks
  43                 are used which do not belong to the according result set.
  44      */
  45     sequence<long> deleteRows([in]sequence<any> rows)
  46         raises (com::sun::star::sdbc::SQLException);
  47 };
  48
  49
  50 }; }; }; };
  51
  52 /*===========================================================================
  53 ===========================================================================*/
  54 #endif
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */