summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/QueryDescriptor.idl
blob: b5dd7af333a3e6f18c6132944f3b9e4ef40f2942 (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
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
/*************************************************************************
 *
 *  $RCSfile: QueryDescriptor.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-08 12:43:31 $
 *
 *  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_QueryDescriptor_idl__
#define __com_sun_star_sdb_QueryDescriptor_idl__

#ifndef __com_sun_star_sdbcx_Descriptor_idl__
#include <com/sun/star/sdbcx/Descriptor.idl>
#endif

 module com {  module sun {  module star {  module sdbcx {
interface XDataDescriptorFactory;
interface XColumnsSupplier;
};};};};

#ifndef __com_sun_star_sdb_DataSettings_idl__
#include <com/sun/star/sdb/DataSettings.idl>
#endif

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


// DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor
/** A query is a stored definition of a SQL "Select statement".

    <p>It can be used, if there is a need to execute SQL statement more than once or
    if you want to format the query result fields different from the
    underlying table definitions.</p>
 */
service QueryDescriptor
{
    // DocMerge: empty anyway
    service com::sun::star::sdbcx::Descriptor;


    // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor: interface com::sun::star::sdbcx::XDataDescriptorFactory
    /** is provided for creation of a new query descriptor based on the current informations.
     */
    interface com::sun::star::sdbcx::XDataDescriptorFactory;


    // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor: service com::sun::star::sdb::DataSettings
    /** is used for customization of data appearance.
     */
    service com::sun::star::sdb::DataSettings;


    // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor: interface com::sun::star::sdbcx::XColumnsSupplier
    /** access to the columns of the results sets query.
     */
    interface com::sun::star::sdbcx::XColumnsSupplier;


    // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::Command
    /** is the command of the query, this is typically a select statement.
     */
    [property] string Command;


    // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::EscapeProcessing
    /** should we use escape processing for the query.
     */
    [property] boolean EscapeProcessing;


    // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::UpdateTableName
    /** is the name of the table which should be updated, this is usually used
        for queries which relate on more than one table.
     */
    [property] string UpdateTableName;


    // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::UpdateCatalogName
    /** is the name of the update table catalog.
     */
    [property] string UpdateCatalogName;


    // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::UpdateSchemaName
    /** is the name of the update table schema.
     */
    [property] string UpdateSchemaName;
};

//=============================================================================

}; }; }; };

/*===========================================================================
    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:37  hjs
    initial import

    Revision 1.4  2000/09/11 11:52:39  mi
    documentation merged from XML

    Revision 1.2  2000/06/05 13:35:37  dg
    services changed

    Revision 1.1  2000/06/05 13:19:53  dg
    new services


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