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

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