xref: /aoo41x/main/offapi/com/sun/star/sdb/XCompletedConnection.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_sdb_XCompletedConnection_idl__
#define __com_sun_star_sdb_XCompletedConnection_idl__

#ifndef __com_sun_star_task_XInteractionHandler_idl__
#include <com/sun/star/task/XInteractionHandler.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;
};};};};

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


/** is used for establishing connections via a factory which is identified
	by it's 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