offapi/com/sun/star/sdbc/XRowSet.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: XRowSet.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_sdbc_XRowSet_idl__
  31 #define __com_sun_star_sdbc_XRowSet_idl__
  32
  33 #ifndef __com_sun_star_sdbc_XResultSet_idl__
  34 #include <com/sun/star/sdbc/XResultSet.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdbc {
  38
  39  published interface XRowSetListener;
  40  published interface XConnection;
  41
  42
  43 /** enhances the functionality of a result set. It allows implementation of
  44     a special behavior for a result set and notifies an application on
  45     certain row set events such as a change in its value.
  46
  47
  48
  49     <p>
  50     The XRowSet interface is unique in that it is intended to be
  51     a software layer on top of an SDBC driver. Implementations of the
  52     RowSet interface can be provided by anyone.
  53     </p>
  54  */
  55 published interface XRowSet: XResultSet
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** populates a row set with data. The description of the data source and
  60         other important information for filling the row set with data.
  61
  62         @throws SQLException
  63             if a database access error occurs.
  64      */
  65     void execute() raises (SQLException);
  66     //-------------------------------------------------------------------------
  67
  68     /** adds the specified listener to receive the events "cursorMoved",
  69         "rowChanged", and "rowSetChanged".
  70         @param listener
  71             the listener which should be registered
  72      */
  73     [oneway] void addRowSetListener([in]XRowSetListener listener );
  74     //-------------------------------------------------------------------------
  75
  76     /** removes the specified listener.
  77         @param listener
  78             the listener which should be registered
  79      */
  80     [oneway] void removeRowSetListener([in]XRowSetListener listener );
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 /*===========================================================================
  88 ===========================================================================*/
  89 #endif