summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl
blob: 26c29b2231bb933f9266133b88302494ea0102cf (plain)
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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */
#ifndef __com_sun_star_sdb_SingleSelectQueryComposer_idl__
#define __com_sun_star_sdb_SingleSelectQueryComposer_idl__

#include <com/sun/star/sdb/SingleSelectQueryAnalyzer.idl>
#include <com/sun/star/beans/XPropertySet.idl>

module com {  module sun {  module star {  module sdb {

interface XSingleSelectQueryComposer;
/** represents a service for composing a single select statement.

    <p>
    It hides the complexity of parsing and evaluating a single select statement and provides
    sophisticated methods for expanding a statement with filter, group by, having and order
    criteria. To get the new extended statement use the methods from <type scope="com::sun::star::sdb">SingleSelectQueryAnalyzer</type>.
    </p>

    <p>A <type>SingleSelectQueryComposer</type> is usually obtained from a <type>Connection</type>
    using the <type scope="com::sun::star::lang">XMultiServiceFactory</type> interface.</p>
 */
service SingleSelectQueryComposer
{
    // gives access to the properties.
    interface com::sun::star::beans::XPropertySet;

    /** access to the analyzer service.
     */
    service SingleSelectQueryAnalyzer;

    interface XSingleSelectQueryComposer;

    /** is the original SQL statement set with the interface <type scope="com::sun::star::sdb">XSingleSelectQueryAnalyzer</type>.
    */
    [readonly, property] string Original;
};


}; }; }; };

/*===========================================================================
===========================================================================*/
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */