xref: /trunk/main/offapi/com/sun/star/sdbc/XIsolatedConnection.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdbc_XIsolatedConnection_idl__
28#define __com_sun_star_sdbc_XIsolatedConnection_idl__
29
30#ifndef __com_sun_star_task_XInteractionHandler_idl__
31#include <com/sun/star/task/XInteractionHandler.idl>
32#endif
33
34#ifndef __com_sun_star_sdbc_SQLException_idl__
35#include <com/sun/star/sdbc/SQLException.idl>
36#endif
37
38 module com {  module sun {  module star {  module sdbc {
39
40 published interface XConnection;
41/** is used for establishing isolated connections via a factory.
42    <p>
43    The <type>XIsolatedConnection</type> allows to create connections which are not shared among others
44    as it is the case when creating connections in normal way.
45    </p>
46    @see com::sun::star::sdb::DataSource
47    @since OOo 1.1.2
48 */
49published interface XIsolatedConnection: com::sun::star::uno::XInterface
50{
51    /** attempts to establish a database connection.
52        <p>If information is missing, such as
53        a user's password, they are completed by user interaction.</p>
54        @param handler
55            The handler which ask for the needed information when they are missing.
56        @returns
57            A connection which is not shared.
58        @throws com::sun::star::sdbc::SQLException
59            when an error occurs.
60     */
61    XConnection
62        getIsolatedConnectionWithCompletion([in]com::sun::star::task::XInteractionHandler handler)
63            raises (SQLException);
64
65    /** attempts to establish a database connection.
66        @param user
67            The user name.
68        @param password
69            The password.
70        @returns
71            A connection which is not shared.
72        @throws com::sun::star::sdbc::SQLException
73            when an error occurs.
74     */
75    XConnection getIsolatedConnection([in]string user, [in]string password)
76        raises (SQLException);
77};
78
79//=============================================================================
80
81}; }; }; };
82
83/*===========================================================================
84===========================================================================*/
85#endif
86