xref: /aoo41x/main/offapi/com/sun/star/sdbc/XPooledConnection.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_sdbc_XPooledConnection_idl__
#define __com_sun_star_sdbc_XPooledConnection_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

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

 module com {  module sun {  module star {  module sdbc {

 published interface XConnection;

/** defines a pooled connection which can share a unused connection.

<!-- JRH: unclear meaning -->

	<p>
	PoolConnections are handled by the connection pool.
	</p>
	<p>
	When the method
	<member scope="com::sun::star::sdbc">XPooledConnection::getConnection()</member>
	is called, the PooledConnection returns the connection which is pooled.
	</p>

	@see com::sun::star::sdbc::XConnection
 */
published interface XPooledConnection: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

	/** return the connection which is pooled
		@returns
			the pooled Connection object
		@throws SQLException
			if a database access error occurs.
	 */
	XConnection getConnection()
		raises (SQLException);
};

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

}; }; }; };

#endif