xref: /aoo41x/main/offapi/com/sun/star/sdb/ParametersRequest.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_ParametersRequest_idl__
#define __com_sun_star_sdb_ParametersRequest_idl__

#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
#include <com/sun/star/task/ClassifiedInteractionRequest.idl>
#endif

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif
#ifndef __com_sun_star_sdbc_XConnection_idl__
#include <com/sun/star/sdbc/XConnection.idl>
#endif

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

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

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

/** an error specifying the lack of parameters values
	<p>
	Usually thrown if someone tries to execute an SQL statement containing
	parameters which can't be filled by the executing instance.
	</p>
*/
published exception ParametersRequest: com::sun::star::task::ClassifiedInteractionRequest
{
	/** is the list of parameters requested.
		The objects returned by the
		<type scope="com::sun::star::container">XIndexAccess</type>
		have to
		be property sets describing the respective parameter. For this, the objects have to support the
		service <type scope="com::sun::star::sdbcx">Column</type>.
	*/
	com::sun::star::container::XIndexAccess Parameters;

	/** specifies the connection on which the statement is to be executed.
		Somebody handling the request could, e.g., use the connection for determining
		the identifier quote string, etc.
	*/
	com::sun::star::sdbc::XConnection		Connection;
};

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

}; }; }; };

/*=============================================================================

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