offapi/com/sun/star/sdbc/ResultSet.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 XStatement;
  23  published interface XRow;
  24  published interface XRowUpdate;
  25  published interface XResultSet;
  26  published interface XResultSetUpdate;
  27  published interface XResultSetMetaDataSupplier;
  28  published interface XWarningsSupplier;
  29  published interface XColumnLocate;
  30  published interface XCloseable;
  31
  32
  33 /** provides access to a table of data. A ResultSet
  34     object is usually generated by executing a Statement.
  35
  36
  37
  38     <p>
  39     A ResultSet maintains a cursor pointing to its current row of
  40     data. Initially the cursor is positioned before the first row.
  41     The "next" method moves the cursor to the next row.
  42     </p>
  43     <p>
  44     The getXXX methods retrieve column values for the current
  45     row. You can retrieve values using either the index number of the
  46     column. Columns are numbered from 1.
  47     </p>
  48     <p>
  49     For maximum portability, ResultSet columns within each row should be
  50     read in left-to-right order and each column should be read only once.
  51     </p>
  52     <p>
  53     For the getXXX methods, the SDBC driver attempts to convert the
  54     underlying data to the specified type and returns a suitable
  55     value.
  56     </p>
  57     <p>
  58     Column names used as input to the findColumn method are case
  59     insensitive. When several columns have the same name, then the value
  60     of the first matching column will be returned. The column name option is
  61     designed to be used when column names are used in the SQL
  62     query. For columns that are NOT explicitly named in the query, it
  63     is best to use column numbers. If column names are used, there is
  64     no way for the programmer to guarantee that they actually refer to
  65     the intended columns.
  66     </p>
  67     <p>
  68     A ResultSet is automatically closed (disposed) by the Statement that
  69     generated it when that Statement is closed, re-executed, or used
  70     to retrieve the next result from a sequence of multiple results.
  71     </p>
  72     <p>
  73     The number, types, and properties of a ResultSet's columns are
  74     provided by the ResultSetMetaData object returned by the getMetaData
  75     method.
  76     </p>
  77  */
  78 published service ResultSet
  79 {
  80
  81     /** optional for implementation; controls the releasing of resources
  82              and the notification of registered listeners.
  83      */
  84     [optional] interface com::sun::star::lang::XComponent;
  85
  86
  87     /** freeing all resources of a result set.
  88
  89                 <p>
  90                 The creating statement will still be open after disposing.
  91                 </p>
  92
  93                 <p>
  94                 This interface is mandatory only for JDBC conformance,
  95                 otherwise it is optional.
  96                 </p>
  97      */
  98     [optional] interface XCloseable;
  99
 100     // gives access to the properties.
 101     interface com::sun::star::beans::XPropertySet;
 102
 103
 104     /** controls the chaining of warnings, which may occur on every call
 105                 to the connected database.
 106
 107                  <p>
 108                 Chained warnings from previous calls will be cleared before processing a new call.
 109                 </p>
 110
 111                 <p>
 112                 This interface is mandatory only for JDBC conformance, otherwise it is optional.
 113                 </p>
 114      */
 115     [optional] interface XWarningsSupplier;
 116
 117
 118     /** provides the access to the result set description.
 119      */
 120     interface XResultSetMetaDataSupplier;
 121
 122
 123     /** is the interface for navigating on the rows on a result set.
 124      */
 125     interface XResultSet;
 126
 127
 128     /** is the interface for updating row data to the database.
 129
 130                 <p>
 131                 The implementation is optional.
 132                 </p>
 133      */
 134     [optional] interface XResultSetUpdate;
 135
 136
 137     /** is the interface for accessing the data of the current row.
 138      */
 139     interface XRow;
 140
 141
 142     /** is used for locating a column by its name.
 143      */
 144     interface XColumnLocate;
 145
 146
 147     /** is the interface for updating the data of the current row.
 148
 149                 <p>
 150                 The implementation is optional.
 151                 </p>
 152      */
 153     [optional] interface XRowUpdate;
 154
 155
 156     /** defines the SQL cursor name that will be used by subsequent Statement
 157         <code>execute</code>
 158         methods.
 159
 160
 161         <p>
 162         This name can then be used in SQL positioned update/delete statements to
 163         identify the current row in the ResultSet generated by this statement. If
 164         the database doesn't support positioned update/delete, this property is
 165         a noop. To ensure that a cursor has the proper isolation level to support
 166         updates, the cursor's SELECT statement should be of the form
 167         "select for update ...". If the "for update" phrase is omitted,
 168         positioned updates may fail.
 169         </p>
 170         <p>
 171         <b>
 172         Note:
 173         </b>
 174         By definition, positioned update/delete
 175         execution must be done by a different Statement than the one
 176         which generated the ResultSet being used for positioning. Also,
 177         cursor names must be unique within a connection.
 178         </p>
 179      */
 180     [optional, readonly, property] string CursorName;
 181
 182
 183     /** retrieves the result set concurrency.
 184
 185         @see com::sun::star::sdbc::ResultSetConcurrency
 186      */
 187     [readonly, property] long ResultSetConcurrency;
 188
 189
 190     /** determines the result set type.
 191
 192         @see com::sun::star::sdbc::ResultSetType
 193      */
 194     [readonly, property] long ResultSetType;
 195
 196
 197     /** retrieves the direction for fetching rows from database tables
 198         that is the default for result sets generated from this
 199         com::sun::star::sdbcx::Statement
 200         object.
 201         <br/>
 202         If this <code>Statement</code> object has not set a fetch direction,
 203         the return value is implementation-specific.
 204      */
 205     [property] long FetchDirection;
 206
 207
 208     /** retrieves the number of result set rows that is the default fetch size
 209         for result sets generated from this
 210         com::sun::star::sdbcx::Statement
 211         object.
 212         <br/>
 213         If this
 214         com::sun::star::sdbcx::Statement
 215         object has not set a fetch size,
 216         the return value is implementation-specific.
 217      */
 218     [property] long FetchSize;
 219 };
 220
 221
 222 }; }; }; };
 223
 224 /*===========================================================================
 225 ===========================================================================*/
 226
 227 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */