summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdb/XCompletedConnection.idl
blob: 1e29db206bdb5a64fe6134a8efcddd7e5a8ce8ee (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
/* -*- 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_sdb_XCompletedConnection_idl__
#define __com_sun_star_sdb_XCompletedConnection_idl__

#include <com/sun/star/task/XInteractionHandler.idl>

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

 module com {  module sun {  module star {  module sdbc {
 published interface XConnection;
};};};};

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


/** is used for establishing connections via a factory which is identified
    by its name. To complete the information needed for establishing a connection
    an interaction handler is used.
 */
published interface XCompletedConnection: com::sun::star::uno::XInterface
{

    /** attempts to establish a database connection. If information is missing, such as
        a user's password, they are completed by user interaction.
        @param handler
            will be asked when more information is needed
        @returns
            the Connection object
        @throws com::sun::star::sdbc::SQLException
            if a database access error occurs.
     */
    com::sun::star::sdbc::XConnection
        connectWithCompletion([in]com::sun::star::task::XInteractionHandler handler)
             raises (com::sun::star::sdbc::SQLException);
};


}; }; }; };

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

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