offapi/com/sun/star/sdbc/Statement.idl

   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 XWarningsSupplier;
  23  published interface XStatement;
  24  published interface XBatchExecution;
  25  published interface XMultipleResults;
  26  published interface XCloseable;
  27
  28
  29 /** is used for executing a static SQL statement and obtaining the results
  30     produced by it.
  31
  32     <p>
  33     Only one ResultSet per Statement can be open at any point in
  34     time. Therefore, if the reading of one ResultSet is interleaved
  35     with the reading of another, each must have been generated by
  36     different Statements. All statement <code>execute</code> methods implicitly
  37     close a statement's current ResultSet if an open one exists.
  38     </p>
  39  */
  40 published service Statement
  41 {
  42
  43     /** optional for implementation, controls the releasing of resources
  44              and the notification of registered listeners.
  45      */
  46     [optional] interface com::sun::star::lang::XComponent;
  47
  48
  49     /** freeing all resources of a statement. A related result set will be
  50              freed as well.
  51      */
  52     interface XCloseable;
  53
  54     // gives access to the properties.
  55     interface com::sun::star::beans::XPropertySet;
  56
  57     /** could be used for canceling the execution of SQL statements if both
  58              the DBMS and the driver support aborting an SQL statement.
  59              The implementation is optional.
  60      */
  61     [optional] interface com::sun::star::util::XCancellable;
  62
  63     /** is the interface for executing SQL commands.
  64      */
  65     interface XStatement;
  66
  67
  68     /** provides the ability of batch execution. This interface is optional
  69              for execution.
  70              <p>
  71              A driver implementing batch execution must return
  72              `TRUE`
  73              for
  74              com::sun::star::sdbc:: XDatabaseMetaData::supportsBatchUpdates()
  75              </p>
  76      */
  77     [optional] interface XBatchExecution;
  78
  79
  80     /** controls the chaining of warnings, which may occur on every call
  81              to the connected database. Chained warnings from previous calls will be
  82              cleared before processing a new call.
  83      */
  84     interface XWarningsSupplier;
  85
  86
  87     /** covers the handling of multiple results after executing an SQL command.
  88                 The implementation is optional.
  89      */
  90     [optional] interface XMultipleResults;
  91
  92
  93     /** retrieves the number of seconds the driver will wait for a Statement
  94         to execute. If the limit is exceeded, a SQLException is thrown.
  95         There is no limitation, if set to zero.
  96      */
  97     [property] long QueryTimeOut;
  98
  99
 100     /**  returns the maximum number of bytes allowed for any column value.
 101
 102         <p>
 103         This limit is the maximum number of bytes that can be returned
 104         for any column value. The limit applies only to
 105         com::sun::star::sdbc::DataType::BINARY
 106               ,
 107               com::sun::star::sdbc::DataType::VARBINARY
 108               ,
 109               com::sun::star::sdbc::DataType::LONGVARBINARY
 110               ,
 111               com::sun::star::sdbc::DataType::CHAR
 112               ,
 113               com::sun::star::sdbc::DataType::VARCHAR
 114               ,
 115               and
 116               com::sun::star::sdbc::DataType::LONGVARCHAR
 117               columns.
 118         If the limit is exceeded, the excess data is silently discarded.
 119         <br/>
 120         There is no limitation, if set to zero.
 121         </p>
 122      */
 123     [property] long MaxFieldSize;
 124
 125
 126     /** retrieves the maximum number of rows that a ResultSet can contain.
 127         If the limit is exceeded, the excess rows are silently dropped.
 128         <br/>
 129         There is no limitation, if set to zero.
 130      */
 131     [property] long MaxRows;
 132
 133
 134     /** defines the SQL cursor name that will be used by subsequent Statement
 135         <code>execute</code>
 136         methods.
 137
 138         <p>
 139         This name can then be used in SQL positioned update/delete statements to
 140         identify the current row in the ResultSet generated by this statement. If
 141         the database does not support positioned update/delete, this property is
 142         a noop. To ensure that a cursor has the proper isolation level to support
 143         updates, the cursor's SELECT statement should be of the form
 144         "select for update ...". If the "for update" phrase is omitted,
 145         positioned updates may fail.
 146         </p>
 147         <p>
 148         <b>
 149         Note:
 150         </b>
 151         By definition, positioned update/delete
 152         execution must be done by a different Statement than the one
 153         which generated the ResultSet being used for positioning. Also,
 154         cursor names must be unique within a connection.
 155         </p>
 156      */
 157     [property] string CursorName;
 158
 159
 160     /** retrieves the result set concurrency.
 161
 162         @see com::sun::star::sdbc::ResultSetConcurrency
 163      */
 164     [property] long ResultSetConcurrency;
 165
 166
 167     /** determine the result set type.
 168
 169         @see com::sun::star::sdbc::ResultSetType
 170      */
 171     [property] long ResultSetType;
 172
 173
 174     /** retrieves the direction for fetching rows from database tables
 175         that is the default for result sets generated from this
 176         <code>Statement</code>
 177         object.
 178         <br/>
 179         If this
 180         <code>Statement</code>
 181         object has not set a fetch direction,
 182         the return value is implementation-specific.
 183      */
 184     [property] long FetchDirection;
 185
 186
 187     /** retrieves the number of result set rows that is the default fetch size
 188         for result sets generated from this
 189         <code>Statement</code>
 190         object.
 191         <br/>
 192         If this
 193         <code>Statement</code>
 194         object has not set a fetch size,
 195         the return value is implementation-specific.
 196      */
 197     [property] long FetchSize;
 198
 199
 200     /** returns if escape processing is on or off.
 201         If escape scanning is on (the default), the driver will do
 202         escape substitution before sending the SQL to the database.
 203      */
 204     [property] boolean EscapeProcessing;
 205 };
 206
 207
 208 }; }; }; };
 209
 210 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */