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