1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdb_QueryDescriptor_idl__
24#define __com_sun_star_sdb_QueryDescriptor_idl__
25
26#ifndef __com_sun_star_sdbcx_Descriptor_idl__
27#include <com/sun/star/sdbcx/Descriptor.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdbcx {
31 published interface XDataDescriptorFactory;
32 published interface XColumnsSupplier;
33};};};};
34
35#ifndef __com_sun_star_sdb_DataSettings_idl__
36#include <com/sun/star/sdb/DataSettings.idl>
37#endif
38
39 module com {  module sun {  module star {  module sdb {
40
41
42/** is a stored definition of a SQL "Select statement".
43
44	<p>
45	It can be used, if there is a need to execute SQL statement more than once or
46	if you want to format the query result fields different from the
47	underlying table definitions.
48	</p>
49 */
50published service QueryDescriptor
51{
52	service com::sun::star::sdbcx::Descriptor;
53
54
55	/** is provided for creation of a new query descriptor based on the current information.
56	 */
57	interface com::sun::star::sdbcx::XDataDescriptorFactory;
58
59
60	/** is used for customization of data appearance.
61	 */
62	service com::sun::star::sdb::DataSettings;
63
64
65	/** access to the columns of the results sets query.
66	 */
67	interface com::sun::star::sdbcx::XColumnsSupplier;
68
69
70	/** is the command of the query, this is typically a select statement.
71	 */
72	[property] string Command;
73
74
75	/** should we use escape processing for the query.
76	 */
77	[property] boolean EscapeProcessing;
78
79
80	/** is the name of the table which should be updated. This is usually used
81		for queries which relate on more than one table.
82	 */
83	[property] string UpdateTableName;
84
85
86	/** is the name of the update table catalog.
87	 */
88	[property] string UpdateCatalogName;
89
90
91	/** is the name of the update table schema.
92	 */
93	[property] string UpdateSchemaName;
94};
95
96//=============================================================================
97
98}; }; }; };
99
100/*===========================================================================
101===========================================================================*/
102#endif
103