LibreOffice: com/sun/star/sdbc/Statement.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

Statement.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef __com_sun_star_sdbc_Statement_idl__
20#define __com_sun_star_sdbc_Statement_idl__
21
22#include <com/sun/star/lang/XComponent.idl>
23
24#include <com/sun/star/beans/XPropertySet.idl>
25
26#include <com/sun/star/util/XCancellable.idl>
27
28 module com { module sun { module star { module sdbc {
29
30 published interface XWarningsSupplier;
31 published interface XStatement;
32 published interface XBatchExecution;
33 published interface XMultipleResults;
34 published interface XCloseable;
35
36
48published service Statement
49{
50
54 [optional] interface com::sun::star::lang::XComponent;
55
56
60 interface XCloseable;
61
62 // gives access to the properties.
63 interface com::sun::star::beans::XPropertySet;
64
69 [optional] interface com::sun::star::util::XCancellable;
70
73 interface XStatement;
74
75
85 [optional] interface XBatchExecution;
86
87
92 interface XWarningsSupplier;
93
94
98 [optional] interface XMultipleResults;
99
100
105 [property] long QueryTimeOut;
106
107
131 [property] long MaxFieldSize;
132
133
139 [property] long MaxRows;
140
141
165 [property] string CursorName;
166
167
172 [property] long ResultSetConcurrency;
173
174
179 [property] long ResultSetType;
180
181
192 [property] long FetchDirection;
193
194
205 [property] long FetchSize;
206
207
212 [property] boolean EscapeProcessing;
213};
214
215
216}; }; }; };
217
218#endif
219
220/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XCancellable.idl
XComponent.idl
XPropertySet.idl
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:43
com::sun::star::sdbc::XBatchExecution
is used for collecting and executing a set of SQL statements.
Definition: XBatchExecution.idl:34
com::sun::star::sdbc::XCloseable
provides for the releasing of resources acquired by the implementing object.
Definition: XCloseable.idl:32
com::sun::star::sdbc::XMultipleResults
is used for inspecting multiple results produced by the execution of a SQL statement.
Definition: XMultipleResults.idl:53
com::sun::star::sdbc::XStatement
is used for executing a static SQL statement and obtaining the results produced by it.
Definition: XStatement.idl:48
com::sun::star::sdbc::XWarningsSupplier
should be implemented of objects which may report warnings or non critical errors.
Definition: XWarningsSupplier.idl:34
com::sun::star::util::XCancellable
offers the possibility of canceling a job.
Definition: XCancellable.idl:34
com
Definition: Accessible.idl:22
com::sun::star::sdbc::Statement
is used for executing a static SQL statement and obtaining the results produced by it.
Definition: Statement.idl:49
com::sun::star::sdbc::Statement::ResultSetConcurrency
long ResultSetConcurrency
retrieves the result set concurrency.
Definition: Statement.idl:172
com::sun::star::sdbc::Statement::CursorName
string CursorName
defines the SQL cursor name that will be used by subsequent Statement execute methods.
Definition: Statement.idl:165
com::sun::star::sdbc::Statement::ResultSetType
long ResultSetType
determine the result set type.
Definition: Statement.idl:179
com::sun::star::sdbc::Statement::FetchSize
long FetchSize
retrieves the number of result set rows that is the default fetch size for result sets generated from...
Definition: Statement.idl:205
com::sun::star::sdbc::Statement::FetchDirection
long FetchDirection
retrieves the direction for fetching rows from database tables that is the default for result sets ge...
Definition: Statement.idl:192
com::sun::star::sdbc::Statement::MaxRows
long MaxRows
retrieves the maximum number of rows that a ResultSet can contain.
Definition: Statement.idl:139
com::sun::star::sdbc::Statement::QueryTimeOut
long QueryTimeOut
retrieves the number of seconds the driver will wait for a Statement to execute.
Definition: Statement.idl:98
com::sun::star::sdbc::Statement::EscapeProcessing
boolean EscapeProcessing
returns if escape processing is on or off.
Definition: Statement.idl:212
com::sun::star::sdbc::Statement::MaxFieldSize
long MaxFieldSize
returns the maximum number of bytes allowed for any column value.
Definition: Statement.idl:131