offapi/com/sun/star/sdbcx/ResultSet.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_ResultSet_idl__
  20 #define __com_sun_star_sdbcx_ResultSet_idl__
  21
  22 #include <com/sun/star/sdbc/ResultSet.idl>
  23
  24  module com {  module sun {  module star {  module sdbcx {
  25
  26  published interface XRowLocate;
  27  published interface XDeleteRows;
  28
  29
  30 /** extends the SDBC ResultSet by the possibility of bookmark positioning, canceling
  31     the positioning, and updating of rows.
  32  */
  33 published service ResultSet
  34 {
  35     service com::sun::star::sdbc::ResultSet;
  36
  37
  38     /** could be used for canceling the execution of SQL statements if both
  39  the DBMS and the driver support aborting of navigation commands.
  40  The implementation is optional.
  41      */
  42     [optional] interface com::sun::star::util::XCancellable;
  43
  44
  45     /** is the interface for navigating on the result set by unique bookmarks.
  46      */
  47     interface XRowLocate;
  48
  49
  50     /** is the interface for deleting more than one row, identified by its bookmark.
  51               The implementation is optional.
  52      */
  53     [optional] interface XDeleteRows;
  54
  55
  56     /** returns if the result set supports bookmark navigation.
  57      */
  58     [readonly, property] boolean IsBookmarkable;
  59
  60
  61     /** returns whether the result set supports updating of newly inserted rows.
  62         This may not work, as the result set may contain automatic generated data
  63         which is used as key information.
  64      */
  65     [optional, readonly, property] boolean CanUpdateInsertedRows;
  66 };
  67
  68
  69 }; }; }; };
  70
  71 /*===========================================================================
  72 ===========================================================================*/
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */