1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdb_QueryDescriptor_idl__
28#define __com_sun_star_sdb_QueryDescriptor_idl__
29
30#ifndef __com_sun_star_sdbcx_Descriptor_idl__
31#include <com/sun/star/sdbcx/Descriptor.idl>
32#endif
33
34 module com {  module sun {  module star {  module sdbcx {
35 published interface XDataDescriptorFactory;
36 published interface XColumnsSupplier;
37};};};};
38
39#ifndef __com_sun_star_sdb_DataSettings_idl__
40#include <com/sun/star/sdb/DataSettings.idl>
41#endif
42
43 module com {  module sun {  module star {  module sdb {
44
45
46/** is a stored definition of a SQL "Select statement".
47
48	<p>
49	It can be used, if there is a need to execute SQL statement more than once or
50	if you want to format the query result fields different from the
51	underlying table definitions.
52	</p>
53 */
54published service QueryDescriptor
55{
56	service com::sun::star::sdbcx::Descriptor;
57
58
59	/** is provided for creation of a new query descriptor based on the current information.
60	 */
61	interface com::sun::star::sdbcx::XDataDescriptorFactory;
62
63
64	/** is used for customization of data appearance.
65	 */
66	service com::sun::star::sdb::DataSettings;
67
68
69	/** access to the columns of the results sets query.
70	 */
71	interface com::sun::star::sdbcx::XColumnsSupplier;
72
73
74	/** is the command of the query, this is typically a select statement.
75	 */
76	[property] string Command;
77
78
79	/** should we use escape processing for the query.
80	 */
81	[property] boolean EscapeProcessing;
82
83
84	/** is the name of the table which should be updated. This is usually used
85		for queries which relate on more than one table.
86	 */
87	[property] string UpdateTableName;
88
89
90	/** is the name of the update table catalog.
91	 */
92	[property] string UpdateCatalogName;
93
94
95	/** is the name of the update table schema.
96	 */
97	[property] string UpdateSchemaName;
98};
99
100//=============================================================================
101
102}; }; }; };
103
104/*===========================================================================
105===========================================================================*/
106#endif
107