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