Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 220 insertions, 0 deletions

diff --git a/offapi/com/sun/star/sdbc/Statement.idl b/offapi/com/sun/star/sdbc/Statement.idl
new file mode 100644
index 000000000..6b7868f78
--- /dev/null
+++ b/offapi/com/sun/star/sdbc/Statement.idl
@@ -0,0 +1,220 @@
+/* -*- 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_sdbc_Statement_idl__
+#define __com_sun_star_sdbc_Statement_idl__
+
+#include <com/sun/star/lang/XComponent.idl>
+
+#include <com/sun/star/beans/XPropertySet.idl>
+
+#include <com/sun/star/util/XCancellable.idl>
+
+ module com {  module sun {  module star {  module sdbc {
+
+ published interface XWarningsSupplier;
+ published interface XStatement;
+ published interface XBatchExecution;
+ published interface XMultipleResults;
+ published interface XCloseable;
+
+
+/** is used for executing a static SQL statement and obtaining the results
+    produced by it.
+
+    <p>
+    Only one ResultSet per Statement can be open at any point in
+    time. Therefore, if the reading of one ResultSet is interleaved
+    with the reading of another, each must have been generated by
+    different Statements. All statement <code>execute</code> methods implicitly
+    close a statement's current ResultSet if an open one exists.
+    </p>
+ */
+published service Statement
+{
+
+    /** optional for implementation, controls the releasing of resources
+             and the notification of registered listeners.
+     */
+    [optional] interface com::sun::star::lang::XComponent;
+
+
+    /** freeing all resources of a statement. A related result set will be
+             freed as well.
+     */
+    interface XCloseable;
+
+    // gives access to the properties.
+    interface com::sun::star::beans::XPropertySet;
+
+    /** could be used for canceling the execution of SQL statements if both
+             the DBMS and the driver support aborting an SQL statement.
+             The implementation is optional.
+     */
+    [optional] interface com::sun::star::util::XCancellable;
+
+    /** is the interface for executing SQL commands.
+     */
+    interface XStatement;
+
+
+    /** provides the ability of batch execution. This interface is optional
+             for execution.
+             <p>
+             A driver implementing batch execution must return
+             `TRUE`
+             for
+             com::sun::star::sdbc:: XDatabaseMetaData::supportsBatchUpdates()
+             </p>
+     */
+    [optional] interface XBatchExecution;
+
+
+    /** controls the chaining of warnings, which may occur on every call
+             to the connected database. Chained warnings from previous calls will be
+             cleared before processing a new call.
+     */
+    interface XWarningsSupplier;
+
+
+    /** covers the handling of multiple results after executing an SQL command.
+                The implementation is optional.
+     */
+    [optional] interface XMultipleResults;
+
+
+    /** retrieves the number of seconds the driver will wait for a Statement
+        to execute. If the limit is exceeded, a SQLException is thrown.
+        There is no limitation, if set to zero.
+     */
+    [property] long QueryTimeOut;
+
+
+    /**  returns the maximum number of bytes allowed for any column value.
+
+        <p>
+        This limit is the maximum number of bytes that can be returned
+        for any column value. The limit applies only to
+        com::sun::star::sdbc::DataType::BINARY
+              ,
+              com::sun::star::sdbc::DataType::VARBINARY
+              ,
+              com::sun::star::sdbc::DataType::LONGVARBINARY
+              ,
+              com::sun::star::sdbc::DataType::CHAR
+              ,
+              com::sun::star::sdbc::DataType::VARCHAR
+              ,
+              and
+              com::sun::star::sdbc::DataType::LONGVARCHAR
+              columns.
+        If the limit is exceeded, the excess data is silently discarded.
+        <br/>
+        There is no limitation, if set to zero.
+        </p>
+     */
+    [property] long MaxFieldSize;
+
+
+    /** retrieves the maximum number of rows that a ResultSet can contain.
+        If the limit is exceeded, the excess rows are silently dropped.
+        <br/>
+        There is no limitation, if set to zero.
+     */
+    [property] long MaxRows;
+
+
+    /** defines the SQL cursor name that will be used by subsequent Statement
+        <code>execute</code>
+        methods.
+
+        <p>
+        This name can then be used in SQL positioned update/delete statements to
+        identify the current row in the ResultSet generated by this statement. If
+        the database does not support positioned update/delete, this property is
+        a noop. To ensure that a cursor has the proper isolation level to support
+        updates, the cursor's SELECT statement should be of the form
+        "select for update ...". If the "for update" phrase is omitted,
+        positioned updates may fail.
+        </p>
+        <p>
+        <b>
+        Note:
+        </b>
+        By definition, positioned update/delete
+        execution must be done by a different Statement than the one
+        which generated the ResultSet being used for positioning. Also,
+        cursor names must be unique within a connection.
+        </p>
+     */
+    [property] string CursorName;
+
+
+    /** retrieves the result set concurrency.
+
+        @see com::sun::star::sdbc::ResultSetConcurrency
+     */
+    [property] long ResultSetConcurrency;
+
+
+    /** determine the result set type.
+
+        @see com::sun::star::sdbc::ResultSetType
+     */
+    [property] long ResultSetType;
+
+
+    /** retrieves the direction for fetching rows from database tables
+        that is the default for result sets generated from this
+        <code>Statement</code>
+        object.
+        <br/>
+        If this
+        <code>Statement</code>
+        object has not set a fetch direction,
+        the return value is implementation-specific.
+     */
+    [property] long FetchDirection;
+
+
+    /** retrieves the number of result set rows that is the default fetch size
+        for result sets generated from this
+        <code>Statement</code>
+        object.
+        <br/>
+        If this
+        <code>Statement</code>
+        object has not set a fetch size,
+        the return value is implementation-specific.
+     */
+    [property] long FetchSize;
+
+
+    /** returns if escape processing is on or off.
+        If escape scanning is on (the default), the driver will do
+        escape substitution before sending the SQL to the database.
+     */
+    [property] boolean EscapeProcessing;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */