xref: /trunk/main/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_sdb_SingleSelectQueryComposer_idl__
24cdf0e10cSrcweir#define __com_sun_star_sdb_SingleSelectQueryComposer_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_sdb_SingleSelectQueryAnalyzer_idl__
27cdf0e10cSrcweir#include <com/sun/star/sdb/SingleSelectQueryAnalyzer.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__
30cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl>
31cdf0e10cSrcweir#endif
32cdf0e10cSrcweir
33cdf0e10cSrcweirmodule com {  module sun {  module star {  module sdb {
34cdf0e10cSrcweir
35cdf0e10cSrcweirinterface XSingleSelectQueryComposer;
36cdf0e10cSrcweir/** represents a service for composing a single select statement.
37cdf0e10cSrcweir
38cdf0e10cSrcweir    <p>
39cdf0e10cSrcweir    It hides the complexity of parsing and evaluating a single select statement and provides
40cdf0e10cSrcweir    sophisticated methods for expanding a statement with filter, group by, having and order
41cdf0e10cSrcweir    criteria. To get the new extended statement use the methods from <type scope="com::sun::star::sdb">SingleSelectQueryAnalyzer</type>.
42cdf0e10cSrcweir    </p>
43cdf0e10cSrcweir
44cdf0e10cSrcweir    <p>A <type>SingleSelectQueryComposer</type> is usually obtained from a <type>Connection</type>
45cdf0e10cSrcweir    using the <type scope="com::sun::star::lang">XMultiServiceFactory</type> interface.</p>
46cdf0e10cSrcweir */
47cdf0e10cSrcweirservice SingleSelectQueryComposer
48cdf0e10cSrcweir{
49cdf0e10cSrcweir    // gives access to the properties.
50cdf0e10cSrcweir    interface com::sun::star::beans::XPropertySet;
51cdf0e10cSrcweir
52cdf0e10cSrcweir    /** access to the analyzer service.
53cdf0e10cSrcweir     */
54cdf0e10cSrcweir    service SingleSelectQueryAnalyzer;
55cdf0e10cSrcweir
56cdf0e10cSrcweir    interface XSingleSelectQueryComposer;
57cdf0e10cSrcweir
58*0cb2ec91SJohn Bampton    /** is the original SQL statement set with the interface <type scope="com::sun::star::sdb">XSingleSelectQueryAnalyzer</type>.
59cdf0e10cSrcweir    */
60cdf0e10cSrcweir    [readonly, property] string Original;
61cdf0e10cSrcweir};
62cdf0e10cSrcweir
63cdf0e10cSrcweir//=============================================================================
64cdf0e10cSrcweir
65cdf0e10cSrcweir}; }; }; };
66cdf0e10cSrcweir
67cdf0e10cSrcweir/*===========================================================================
68cdf0e10cSrcweir===========================================================================*/
69cdf0e10cSrcweir#endif
70