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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: RowSet.idl,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbc_RowSet_idl__
  31 #define __com_sun_star_sdbc_RowSet_idl__
  32
  33 #ifndef __com_sun_star_sdbc_ResultSet_idl__
  34 #include <com/sun/star/sdbc/ResultSet.idl>
  35 #endif
  36 #ifndef __com_sun_star_sdbc_XColumnLocate_idl__
  37 #include <com/sun/star/sdbc/XColumnLocate.idl>
  38 #endif
  39
  40  module com {  module sun {  module star {  module container {
  41  published interface XNameAccess;
  42 };};};};
  43
  44  module com {  module sun {  module star {  module sdbc {
  45
  46  published interface XRowSet;
  47  published interface XParameters;
  48
  49
  50 /** is a client side ResultSet, which combines the characteristics of a
  51     <type scope="com::sun::star::sdbc">Statement</type>
  52     and a
  53     <type scope="com::sun::star::sdbc">ResultSet</type>.
  54
  55
  56     <p>
  57     It acts like a typical bean. Before you use the RowSet, you have to specify a
  58     set of properties like a DataSource and a Command and other properties known of
  59     Statement.
  60     <br/>
  61     Afterwards, you can populate the RowSet by its execute method to fill the set
  62     with data.
  63     </p>
  64     <p>
  65     On the one hand, a RowSet can be used as a short cut to retrieve the data of a DataSource.
  66     You don't have to establish a connection, create a Statement, and then create
  67     a ResultSet. On the other hand, a rowset can be used to implement capabilties for
  68     a result set, which are not supported by a driver result set, like caching
  69     strategies or update capabilities.
  70     </p>
  71  */
  72 published service RowSet
  73 {
  74     service com::sun::star::sdbc::ResultSet;
  75
  76     /** used to execute and to add/remove listeners.
  77
  78         <p>To refresh the content of a <type>RowSet</type>, use this interface's <member>XRowSet::execute</member>
  79         method.</p>
  80     */
  81     interface XRowSet;
  82
  83     // used to set parameters.
  84     interface XParameters;
  85
  86     /** allows locating columns which's name is known only.
  87     */
  88     interface XColumnLocate;
  89
  90     /** is the name of a named datasource to use.@see com::sun::star::sdbc:XDataSource
  91      */
  92     [property] string DataSourceName;
  93
  94
  95     /** is the connection URL. Could be used instead of the DataSourceName.
  96      */
  97     [property] string URL;
  98
  99
 100     /** is the command which should be executed.
 101      */
 102     [property] string Command;
 103
 104
 105     /** indicates the transaction isolation level, which should be used for the
 106         connection.@see com::sun::star::sdbc::TransactionIsolation
 107      */
 108     [property] long TransactionIsolation;
 109
 110
 111     /** is the type map that will be used for the custom mapping of SQL structured types
 112         and distinct types.
 113      */
 114     [property] com::sun::star::container::XNameAccess TypeMap;
 115
 116
 117     /** returns if escape processing is on or off.
 118         If escape scanning is on (the default), the driver will do
 119         escape substitution before sending the SQL to the database.
 120         This is only evaluated, if the CommandType is COMMAND.
 121      */
 122     [property] boolean EscapeProcessing;
 123
 124
 125     /** retrieves the number of seconds the driver will wait for a Statement
 126         to execute. If the limit is exceeded, a
 127         <type scope="com::sun::star::sdbc">SQLException</type>
 128         is thrown.
 129         There is no limitation, if set to zero.
 130      */
 131     [property] long QueryTimeOut;
 132
 133
 134     /** returns the maximum number of bytes allowed for any column value.
 135
 136         <p>
 137         This limit is the maximum number of bytes that can be returned
 138         for any column value. The limit applies only to
 139         <member scope= "com::sun::star::sdbc">DataType::BINARY</member>
 140               ,
 141               <member scope= "com::sun::star::sdbc">DataType::VARBINARY</member>
 142               ,
 143               <member scope= "com::sun::star::sdbc">DataType::LONGVARBINARY</member>
 144               ,
 145               <member scope= "com::sun::star::sdbc">DataType::CHAR</member>
 146               ,
 147               <member scope= "com::sun::star::sdbc">DataType::VARCHAR</member>
 148               ,
 149               and
 150               <member scope= "com::sun::star::sdbc">DataType::LONGVARCHAR</member>
 151               columns.
 152         If the limit is exceeded, the excess data is silently discarded.
 153         <br/>
 154         There is no limitation, if set to zero.
 155         </p>
 156      */
 157     [property] long MaxFieldSize;
 158
 159
 160     /** retrieves the maximum number of rows that a ResultSet can contain.
 161         If the limit is exceeded, the excess rows are silently dropped.
 162         <br/>
 163         There is no limitation, if set to zero.
 164      */
 165     [property] long MaxRows;
 166
 167
 168     /** determines the user for whom to open the connection.
 169      */
 170     [property] string User;
 171
 172
 173     /** determines the user for whom to open the connection.
 174      */
 175     [property] string Password;
 176
 177
 178     /** determine the result set type.
 179
 180         @see com::sun::star::sdbc::ResultSetType
 181      */
 182     [property] long ResultSetType;
 183 };
 184
 185 //=============================================================================
 186
 187 }; }; }; };
 188
 189 /*===========================================================================
 190 ===========================================================================*/
 191 #endif