xref: /aoo42x/main/offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.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_sdbcx_XDataDefinitionSupplier_idl__
#define __com_sun_star_sdbcx_XDataDefinitionSupplier_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;
};};};};

 module com {  module sun {  module star {  module sdbcx {

 published interface XTablesSupplier;


/** provides the access to data definition beans from a connected database.
 */
published interface XDataDefinitionSupplier: com::sun::star::uno::XInterface
{

	/** returns at least the container of tables related to the given connection.
		@param connection
			the related connection
		@returns
			the container
		@throws com::sun::star::sdbc::SQLException
			if a database access error occurs.
	 */
	XTablesSupplier getDataDefinitionByConnection(
				[in]com::sun::star::sdbc::XConnection connection)
		raises (com::sun::star::sdbc::SQLException);
	//-------------------------------------------------------------------------

	/** returns at least the container of tables related to the given Database URL.
		@param url
			a database url of the form  sdbc:subprotocol:subname
		@param info
			a list of arbitrary string tag/value pairs as connection arguments;
			normally at least a "user" and "password" property should be included
		@returns
			the container
		@throws com::sun::star::sdbc::SQLException
			if a database access error occurs.
	 */
	XTablesSupplier getDataDefinitionByURL(
				[in]string url,
				[in]sequence<com::sun::star::beans::PropertyValue> info)
		raises (com::sun::star::sdbc::SQLException);
};

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

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif