offapi/com/sun/star/sdbc/XRowSet.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbc_XRowSet_idl__
  29 #define __com_sun_star_sdbc_XRowSet_idl__
  30
  31 #include <com/sun/star/sdbc/XResultSet.idl>
  32
  33  module com {  module sun {  module star {  module sdbc {
  34
  35  published interface XRowSetListener;
  36  published interface XConnection;
  37
  38
  39 /** enhances the functionality of a result set. It allows implementation of
  40     a special behavior for a result set and notifies an application on
  41     certain row set events such as a change in its value.
  42
  43
  44
  45     <p>
  46     The XRowSet interface is unique in that it is intended to be
  47     a software layer on top of an SDBC driver. Implementations of the
  48     RowSet interface can be provided by anyone.
  49     </p>
  50  */
  51 published interface XRowSet: XResultSet
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     /** populates a row set with data. The description of the data source and
  56         other important information for filling the row set with data.
  57
  58         @throws SQLException
  59             if a database access error occurs.
  60      */
  61     void execute() raises (SQLException);
  62     //-------------------------------------------------------------------------
  63
  64     /** adds the specified listener to receive the events "cursorMoved",
  65         "rowChanged", and "rowSetChanged".
  66         @param listener
  67             the listener which should be registered
  68      */
  69     [oneway] void addRowSetListener([in]XRowSetListener listener );
  70     //-------------------------------------------------------------------------
  71
  72     /** removes the specified listener.
  73         @param listener
  74             the listener which should be registered
  75      */
  76     [oneway] void removeRowSetListener([in]XRowSetListener listener );
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 /*===========================================================================
  84 ===========================================================================*/
  85 #endif
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */