xref: /trunk/main/offapi/com/sun/star/sdbc/XWarningsSupplier.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_XWarningsSupplier_idl__
#define __com_sun_star_sdbc_XWarningsSupplier_idl__

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

#ifndef __com_sun_star_sdbc_SQLWarning_idl__
#include <com/sun/star/sdbc/SQLWarning.idl>
#endif

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


/** should be implemented of objects which may report warnings or non critical
	errors.
	@see com::sun::star::sdbc::SQLWarning
 */
published interface XWarningsSupplier: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

	/** returns the first warning reported by calls on an object that supports
		the usage of warnings.

		<p>
		<b>Note:</b> Subsequent warnings will be chained to this
		<type scope="com::sun::star::sdbc">SQLWarning</type>
		.
		</p>
		@returns
			the warnings
		@throws SQLException
				if a database access error occurs.
	 */
	any getWarnings() raises (SQLException);

    //-------------------------------------------------------------------------

	/** clears all warnings reported for the object implementing the interface.
		After a call to this method, the method
		<member scope="com::sun::star::sdbc">XWarningsSupplier::getWarnings()</member>
		returns
		<void/>
		until a new warning is reported for the object.
		@throws SQLException
				if a database access error occurs.
	 */
	void clearWarnings() raises (SQLException);
};

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

}; }; }; };

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