AOO410/main/offapi/com/sun/star/sdb/QueryDescriptor.idl

/**************************************************************
 * 
 * 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_QueryDescriptor_idl__ 
#define __com_sun_star_sdb_QueryDescriptor_idl__ 
 
#ifndef __com_sun_star_sdbcx_Descriptor_idl__ 
#include <com/sun/star/sdbcx/Descriptor.idl> 
#endif 
 
 module com {  module sun {  module star {  module sdbcx { 
 published interface XDataDescriptorFactory; 
 published interface XColumnsSupplier; 
};};};}; 
 
#ifndef __com_sun_star_sdb_DataSettings_idl__ 
#include <com/sun/star/sdb/DataSettings.idl> 
#endif 
 
 module com {  module sun {  module star {  module sdb { 
 
 
/** is a stored definition of a SQL "Select statement".
	
	<p>
	It can be used, if there is a need to execute SQL statement more than once or
	if you want to format the query result fields different from the
	underlying table definitions.
	</p>
 */
published service QueryDescriptor
{ 
	service com::sun::star::sdbcx::Descriptor;	 
	 
	 
	/** is provided for creation of a new query descriptor based on the current information.
	 */
	interface com::sun::star::sdbcx::XDataDescriptorFactory;	 
 
	 
	/** is used for customization of data appearance.
	 */
	service com::sun::star::sdb::DataSettings; 
 
	 
	/** access to the columns of the results sets query.
	 */
	interface com::sun::star::sdbcx::XColumnsSupplier; 
	 
	 
	/** is the command of the query, this is typically a select statement.
	 */
	[property] string Command; 
 
	 
	/** should we use escape processing for the query.
	 */
	[property] boolean EscapeProcessing;	 
 
	 
	/** is the name of the table which should be updated. This is usually used
		for queries which relate on more than one table.
	 */
	[property] string UpdateTableName; 
 
	 
	/** is the name of the update table catalog.
	 */
	[property] string UpdateCatalogName; 
 
	 
	/** is the name of the update table schema.
	 */
	[property] string UpdateSchemaName;	 
}; 
 
//============================================================================= 
 
}; }; }; }; 
 
/*=========================================================================== 
===========================================================================*/ 
#endif