xref: /AOO41X/main/offapi/com/sun/star/sdbc/XIsolatedConnection.idl (revision 96af39f745f380c70aec9fab3a79dc8b37f680ac)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbc_XIsolatedConnection_idl__
24#define __com_sun_star_sdbc_XIsolatedConnection_idl__
25
26#ifndef __com_sun_star_task_XInteractionHandler_idl__
27#include <com/sun/star/task/XInteractionHandler.idl>
28#endif
29
30#ifndef __com_sun_star_sdbc_SQLException_idl__
31#include <com/sun/star/sdbc/SQLException.idl>
32#endif
33
34 module com {  module sun {  module star {  module sdbc {
35
36 published interface XConnection;
37/** is used for establishing isolated connections via a factory.
38    <p>
39    The <type>XIsolatedConnection</type> allows to create connections which are not shared among others
40    as it is the case when creating connections in normal way.
41    </p>
42    @see com::sun::star::sdb::DataSource
43    @since OpenOffice 1.1.2
44 */
45published interface XIsolatedConnection: com::sun::star::uno::XInterface
46{
47    /** attempts to establish a database connection.
48        <p>If information is missing, such as
49        a user's password, they are completed by user interaction.</p>
50        @param handler
51            The handler which ask for the needed information when they are missing.
52        @returns
53            A connection which is not shared.
54        @throws com::sun::star::sdbc::SQLException
55            when an error occurs.
56     */
57    XConnection
58        getIsolatedConnectionWithCompletion([in]com::sun::star::task::XInteractionHandler handler)
59            raises (SQLException);
60
61    /** attempts to establish a database connection.
62        @param user
63            The user name.
64        @param password
65            The password.
66        @returns
67            A connection which is not shared.
68        @throws com::sun::star::sdbc::SQLException
69            when an error occurs.
70     */
71    XConnection getIsolatedConnection([in]string user, [in]string password)
72        raises (SQLException);
73};
74
75//=============================================================================
76
77}; }; }; };
78
79/*===========================================================================
80===========================================================================*/
81#endif
82