offapi/com/sun/star/sdbc/RowSet.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 container {
  21  published interface XNameAccess;
  22 };};};};
  23
  24  module com {  module sun {  module star {  module sdbc {
  25
  26  published interface XRowSet;
  27  published interface XParameters;
  28
  29
  30 /** is a client side ResultSet, which combines the characteristics of a
  31     com::sun::star::sdbc::Statement
  32     and a
  33     com::sun::star::sdbc::ResultSet.
  34
  35
  36     <p>
  37     It acts like a typical bean. Before you use the RowSet, you have to specify a
  38     set of properties like a DataSource and a Command and other properties known of
  39     Statement.
  40     <br/>
  41     Afterwards, you can populate the RowSet by its execute method to fill the set
  42     with data.
  43     </p>
  44     <p>
  45     On the one hand, a RowSet can be used as a short cut to retrieve the data of a DataSource.
  46     You don't have to establish a connection, create a Statement, and then create
  47     a ResultSet. On the other hand, a row set can be used to implement capabilities for
  48     a result set, which are not supported by a driver result set, like caching
  49     strategies or update capabilities.
  50     </p>
  51  */
  52 published service RowSet
  53 {
  54     service com::sun::star::sdbc::ResultSet;
  55
  56     /** used to execute and to add/remove listeners.
  57
  58         <p>To refresh the content of a RowSet, use this interface's XRowSet::execute()
  59         method.</p>
  60     */
  61     interface XRowSet;
  62
  63     // used to set parameters.
  64     interface XParameters;
  65
  66     /** allows locating columns whose name is known only.
  67     */
  68     interface XColumnLocate;
  69
  70     /** is the name of a named datasource to use.@see com::sun::star::sdbc:XDataSource
  71      */
  72     [property] string DataSourceName;
  73
  74
  75     /** is the connection URL. Could be used instead of the DataSourceName.
  76      */
  77     [property] string URL;
  78
  79
  80     /** is the command which should be executed.
  81      */
  82     [property] string Command;
  83
  84
  85     /** indicates the transaction isolation level, which should be used for the
  86         connection.@see com::sun::star::sdbc::TransactionIsolation
  87      */
  88     [property] long TransactionIsolation;
  89
  90
  91     /** is the type map that will be used for the custom mapping of SQL structured types
  92         and distinct types.
  93      */
  94     [property] com::sun::star::container::XNameAccess TypeMap;
  95
  96
  97     /** returns if escape processing is on or off.
  98         If escape scanning is on (the default), the driver will do
  99         escape substitution before sending the SQL to the database.
 100         This is only evaluated, if the CommandType is COMMAND.
 101      */
 102     [property] boolean EscapeProcessing;
 103
 104
 105     /** retrieves the number of seconds the driver will wait for a Statement
 106         to execute. If the limit is exceeded, a
 107         com::sun::star::sdbc::SQLException
 108         is thrown.
 109         There is no limitation, if set to zero.
 110      */
 111     [property] long QueryTimeOut;
 112
 113
 114     /** returns the maximum number of bytes allowed for any column value.
 115
 116         <p>
 117         This limit is the maximum number of bytes that can be returned
 118         for any column value. The limit applies only to
 119         com::sun::star::sdbc::DataType::BINARY
 120               ,
 121               com::sun::star::sdbc::DataType::VARBINARY
 122               ,
 123               com::sun::star::sdbc::DataType::LONGVARBINARY
 124               ,
 125               com::sun::star::sdbc::DataType::CHAR
 126               ,
 127               com::sun::star::sdbc::DataType::VARCHAR
 128               ,
 129               and
 130               com::sun::star::sdbc::DataType::LONGVARCHAR
 131               columns.
 132         If the limit is exceeded, the excess data is silently discarded.
 133         <br/>
 134         There is no limitation, if set to zero.
 135         </p>
 136      */
 137     [property] long MaxFieldSize;
 138
 139
 140     /** retrieves the maximum number of rows that a ResultSet can contain.
 141         If the limit is exceeded, the excess rows are silently dropped.
 142         <br/>
 143         There is no limitation, if set to zero.
 144      */
 145     [property] long MaxRows;
 146
 147
 148     /** determines the user for whom to open the connection.
 149      */
 150     [property] string User;
 151
 152
 153     /** determines the user for whom to open the connection.
 154      */
 155     [property] string Password;
 156
 157
 158     /** determine the result set type.
 159
 160         @see com::sun::star::sdbc::ResultSetType
 161      */
 162     [property] long ResultSetType;
 163 };
 164
 165
 166 }; }; }; };
 167
 168 /*===========================================================================
 169 ===========================================================================*/
 170
 171 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */