LibreOffice
LibreOffice 24.2 SDK API Reference
PreparedStatement.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 
20  module com { module sun { module star { module sdbc {
21 
22  published interface XPreparedStatement;
23  published interface XPreparedBatchExecution;
24  published interface XParameters;
25  published interface XWarningsSupplier;
26  published interface XMultipleResults;
27  published interface XResultSetMetaDataSupplier;
28  published interface XCloseable;
29 
30 
76 published service PreparedStatement
77 {
78 
82  [optional] interface com::sun::star::lang::XComponent;
83 
84 
88  interface XCloseable;
89 
90  // gives access to the properties.
92 
97  [optional] interface com::sun::star::util::XCancellable;
98 
102 
103 
108 
109 
113  interface XParameters;
114 
115 
125  [optional] interface XPreparedBatchExecution;
126 
127 
132  interface XWarningsSupplier;
133 
134 
137  interface XMultipleResults;
138 
139 
144  [property] long QueryTimeOut;
145 
146 
170  [property] long MaxFieldSize;
171 
172 
177  [property] long MaxRows;
178 
179 
202  [property] string CursorName;
203 
204 
208  [property] long ResultSetConcurrency;
209 
210 
214  [property] long ResultSetType;
215 
216 
228  [property] long FetchDirection;
229 
230 
242  [property] long FetchSize;
243 };
244 
245 
246 }; }; }; };
247 
248 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
string CursorName
defines the SQL cursor name that will be used by subsequent Statement execute methods.
Definition: PreparedStatement.idl:202
provides the possibility of executing a precompiled SQL statement.
Definition: XPreparedStatement.idl:35
long FetchSize
retrieves the number of result set rows that is the default fetch size for result sets generated from...
Definition: PreparedStatement.idl:242
should be implemented of objects which may report warnings or non critical errors.
Definition: XWarningsSupplier.idl:27
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:38
is used for inspecting multiple results produced by the execution of a SQL statement.
Definition: XMultipleResults.idl:46
Definition: Ambiguous.idl:20
provides access to the meta data of a result set.
Definition: XResultSetMetaDataSupplier.idl:37
is used for batch execution on PreparedStatements.
Definition: XPreparedBatchExecution.idl:34
long MaxRows
retrieves the maximum number of rows that a ResultSet can contain.
Definition: PreparedStatement.idl:177
represents a precompiled SQL statement.
Definition: PreparedStatement.idl:76
provides for the releasing of resources acquired by the implementing object.
Definition: XCloseable.idl:25
long ResultSetType
Determine the result set type.
Definition: PreparedStatement.idl:214
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:45
long MaxFieldSize
returns the maximum number of bytes allowed for any column value.
Definition: PreparedStatement.idl:170
long FetchDirection
retrieves the direction for fetching rows from database tables that is the default for result sets ge...
Definition: PreparedStatement.idl:228
offers the possibility of canceling a job.
Definition: XCancellable.idl:29
long ResultSetConcurrency
retrieves the result set concurrency.
Definition: PreparedStatement.idl:208
is used for parameter setting, commonly implemented in conjunction with PreparedStatements.
Definition: XParameters.idl:64