xref: /AOO41X/main/offapi/com/sun/star/sdb/QueryDefinition.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdb_QueryDefinition_idl__
24#define __com_sun_star_sdb_QueryDefinition_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdb {
31
32
33/** is a stored definition of a SQL "Select statement".
34
35    <p>
36    It can be used, if there is a need to execute SQL statement more than once.
37    </p>
38 */
39published service QueryDefinition
40{
41
42    /** access to the owning database definition object.
43     */
44    interface com::sun::star::beans::XPropertySet;
45
46
47    /** is the name of the definition.
48     */
49    [readonly, property] string Name;
50
51
52    /** is the command of the query, this is typically a select statement.
53     */
54    [property] string Command;
55
56
57    /** should we use escape processing for the query.
58     */
59    [property] boolean EscapeProcessing;
60
61
62    /** is the name of the table which should be updated. This is usually used
63        for queries which relate on more than one table.
64     */
65    [property] string UpdateTableName;
66
67
68    /** is the name of the update table catalog.
69     */
70    [property] string UpdateCatalogName;
71
72
73    /** is the name of the update table schema.
74     */
75    [property] string UpdateSchemaName;
76};
77
78//=============================================================================
79
80}; }; }; };
81
82/*===========================================================================
83===========================================================================*/
84#endif
85