summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbc/XRowSet.idl
blob: cb647e337fe61c8e05afe155f067ab71bfa19afe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_sdbc_XRowSet_idl__
#define __com_sun_star_sdbc_XRowSet_idl__

#include <com/sun/star/sdbc/XResultSet.idl>

 module com {  module sun {  module star {  module sdbc {

 published interface XRowSetListener;
 published interface XConnection;


/** enhances the functionality of a result set. It allows implementation of
    a special behavior for a result set and notifies an application on
    certain row set events such as a change in its value.



    <p>
    The XRowSet interface is unique in that it is intended to be
    a software layer on top of an SDBC driver. Implementations of the
    RowSet interface can be provided by anyone.
    </p>
 */
published interface XRowSet: XResultSet
{

    /** populates a row set with data. The description of the data source and
        other important information for filling the row set with data.

        @throws SQLException
            if a database access error occurs.
     */
    void execute() raises (SQLException);

    /** adds the specified listener to receive the events "cursorMoved",
        "rowChanged", and "rowSetChanged".
        @param listener
            the listener which should be registered
     */
    void addRowSetListener([in]XRowSetListener listener );

    /** removes the specified listener.
        @param listener
            the listener which should be registered
     */
    void removeRowSetListener([in]XRowSetListener listener );
};


}; }; }; };

/*===========================================================================
===========================================================================*/
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */