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
24#ifndef __com_sun_star_sdbc_XPooledConnection_idl__
25#define __com_sun_star_sdbc_XPooledConnection_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_beans_PropertyValue_idl__
32#include <com/sun/star/beans/PropertyValue.idl>
33#endif
34
35#ifndef __com_sun_star_sdbc_SQLException_idl__
36#include <com/sun/star/sdbc/SQLException.idl>
37#endif
38
39 module com {  module sun {  module star {  module sdbc {
40
41 published interface XConnection;
42
43/** defines a pooled connection which can share a unused connection.
44
45<!-- JRH: unclear meaning -->
46
47	<p>
48	PoolConnections are handled by the connection pool.
49	</p>
50	<p>
51	When the method
52	<member scope="com::sun::star::sdbc">XPooledConnection::getConnection()</member>
53	is called, the PooledConnection returns the connection which is pooled.
54	</p>
55
56	@see com::sun::star::sdbc::XConnection
57 */
58published interface XPooledConnection: com::sun::star::uno::XInterface
59{
60    //-------------------------------------------------------------------------
61
62	/** return the connection which is pooled
63		@returns
64			the pooled Connection object
65		@throws SQLException
66			if a database access error occurs.
67	 */
68	XConnection getConnection()
69		raises (SQLException);
70};
71
72//=============================================================================
73
74}; }; }; };
75
76#endif
77