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