summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/XDatabaseAccessListener.idl
blob: 1c9361f9da09a4ef5d83ef22a8784a769e8cd9d3 (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
75
76
77
78
79
80
81
82
83
84
85
86
87
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XDatabaseAccessListener.idl,v $
 * $Revision: 1.11 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sdb_XDatabaseAccessListener_idl__
#define __com_sun_star_sdb_XDatabaseAccessListener_idl__

#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif

 module com {  module sun {  module star {  module sdb {


/** is used for receiving "connectionChanged", "approveConnectionClose", and
    "connectionClosing" events posted by a database access bean.


    <p>
    A database access bean setting may be changed to connect to a different database.
    In that case, the connection of the bean must be closed and a new connection must
    be established. The could affect the current data processing on the bean, as it
    could be shared by a number of components. To prevent the bean from closing it's
    connection, a DatabaseAccessListener could abort the closing.
    </p>
 */
published interface XDatabaseAccessListener: com::sun::star::lang::XEventListener
{

    /** indicates that a new connection for the bean has been established.
        @param evenet
            the event happend
     */
    [oneway] void connectionChanged([in]com::sun::star::lang::EventObject event);
    //-------------------------------------------------------------------------

    /** indicates that the connection of the bean will be closed. If there are pending
        actions on the connection of the bean, "approveConnectionClosing" should return
        <FALSE/>.

        @param evenet
            the event happend
        @returns
            <TRUE/> when approved, otherwise <FALSE/>
     */
    boolean approveConnectionClosing([in]com::sun::star::lang::EventObject event);
    //-------------------------------------------------------------------------

    /** indicates that the connection will definitely be closed.
        @param evenet
            the event happend
     */
    [oneway] void connectionClosing([in]com::sun::star::lang::EventObject event);
};

//=============================================================================

}; }; }; };

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