xref: /aoo41x/main/offapi/com/sun/star/sdbc/XGeneratedResultSet.idl (revision 96af39f7)

/**************************************************************
 *
 * 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_XGeneratedResultSet_idl__
#define __com_sun_star_sdbc_XGeneratedResultSet_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.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 XResultSet;

/** provides a result set which gives access to automatically generated values after a new row was inserted.

	<p>The relative order of columns in the result set returned by <member>getGeneratedValues</member> must be the same
    as the relative order of the same columns as returned when executing a "SELECT * FROM table". This ensures that
    clients of this interface can reliably fetch the column values.</p>

	@see com::sun::star::sdbc::Statement
	@see com::sun::star::sdbc::PreparedStatement
	@since OpenOffice 1.1.2
 */
published interface XGeneratedResultSet: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** gives access to automatically generated values after a new row was inserted.
		@returns
			a result set that contains the data produced by the query
		@throws SQLException
			if a database access error occurs.
	*/
	XResultSet getGeneratedValues() raises (SQLException);

};

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

}; }; }; };

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