1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
/*************************************************************************
*
* $RCSfile: XSQLQueryComposer.idl,v $
*
* $Revision: 1.6 $
*
* last change: $Author: mi $ $Date: 2002-10-03 13:06:42 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_sdb_XSQLQueryComposer_idl__
#define __com_sun_star_sdb_XSQLQueryComposer_idl__
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif
#ifndef __com_sun_star_sdbc_SQLException_idl__
#include <com/sun/star/sdbc/SQLException.idl>
#endif
//=============================================================================
module com { module sun { module star { module sdb {
//=============================================================================
// DocMerge from xml: interface com::sun::star::sdb::XSQLQueryComposer
/** should be provided by a tool which simplifies the handling with SQL select statements.
<p>
The interface can be used for composing SELECT statements without knowing the
structure of the used query.
</p>
*/
interface XSQLQueryComposer: com::sun::star::uno::XInterface
{
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getQuery
/** returns the query used for composing.
@returns
the query
*/
string getQuery();
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setQuery
/** sets a new query for the composer, which may be expanded by filters
and sort criteria.
@param command
the command to set
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
void setQuery([in] string command )
raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getComposedQuery
/** returns the query composed with filters and sort criterias.
@returns
the composed query
*/
string getComposedQuery();
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getFilter
/** returns the currently used filter.
<p>
The filter criteria returned is part of the where condition of the
select command, but it does not contain the where token.
</p>
@returns
the filter
*/
string getFilter();
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::sdb::XSQLQueryComposer::getStructuredFilter
/** returns the currently used filter.
<p>
The filter criteria is split into levels. Each level represents the
OR criterias. Within each level, the filters are provided as an AND criteria
with the name of the column and the filter condition. The filter condition
is of type string.
</p>
@returns
the structured filter
*/
sequence< sequence<com::sun::star::beans::PropertyValue> >
getStructuredFilter();
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getOrder
/** returns the currently used sort order.
<p>
The order criteria returned is part of the ORDER BY clause of the
select command, but it does not contain the ORDER BY keyword .
</p>
@returns
the order
*/
string getOrder();
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::appendFilterByColumn
/** appends a new filter condition by a
<type scope="com::sun::star::sdb">DataColumn</type>
providing the name and the value for the filter.
@param column
the column which is used to create a filter
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
void appendFilterByColumn([in] com::sun::star::beans::XPropertySet column)
raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::appendOrderByColumn
/** appends an additional part to the sort order criteria of the select
statement.
@param column
the column which is used to create a order part
@param ascending
<TRUE/> when the order should be ascending, otherwise <FALSE/>
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
void appendOrderByColumn([in] com::sun::star::beans::XPropertySet column,
[in] boolean ascending)
raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setFilter
/** makes it possible to set a filter condition for the query.
@param filter
the filter to set
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
void setFilter([in] string filter)
raises (com::sun::star::sdbc::SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setOrder
/** makes it possibile to set a sort condition for the query.
@param order
the order part to set
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
void setOrder([in] string order)
raises (com::sun::star::sdbc::SQLException);
};
//=============================================================================
}; }; }; };
/*=============================================================================
$Log: not supported by cvs2svn $
Revision 1.5.2.1 2002/02/18 10:26:19 oj
#97563# parameter,return value and exception description
Revision 1.5 2001/10/25 15:00:32 mi
proofreading and corrections from Richard Holt
Revision 1.4 2001/03/16 16:41:32 jsc
remove interfaceheader with uik and remove [const] in method definitions
Revision 1.3 2000/11/08 12:43:31 mi
moved from api
Revision 1.1.1.1 2000/09/18 23:35:38 hjs
initial import
Revision 1.3 2000/09/11 11:52:41 mi
documentation merged from XML
Revision 1.1 1999/12/08 14:42:26 dg
#70278# new Composer files
Revision 1.1.1.1 1999/11/11 09:48:41 jsc
new
=============================================================================*/
#endif
|
