LibreOffice LibreOffice 7.2 SDK API Reference

RowSet.idl
Go to the documentation of this file.
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#ifndef __com_sun_star_sdbc_RowSet_idl__
20#define __com_sun_star_sdbc_RowSet_idl__
21
22#include <com/sun/star/sdbc/ResultSet.idl>
23#include <com/sun/star/sdbc/XColumnLocate.idl>
24
25 module com { module sun { module star { module container {
26 published interface XNameAccess;
27};};};};
28
29 module com { module sun { module star { module sdbc {
30
31 published interface XRowSet;
32 published interface XParameters;
33
34
57published service RowSet
58{
59 service com::sun::star::sdbc::ResultSet;
60
66 interface XRowSet;
67
68 // used to set parameters.
69 interface XParameters;
70
73 interface XColumnLocate;
74
77 [property] string DataSourceName;
78
79
82 [property] string URL;
83
84
87 [property] string Command;
88
89
93 [property] long TransactionIsolation;
94
95
99 [property] com::sun::star::container::XNameAccess TypeMap;
100
101
107 [property] boolean EscapeProcessing;
108
109
116 [property] long QueryTimeOut;
117
118
142 [property] long MaxFieldSize;
143
144
150 [property] long MaxRows;
151
152
155 [property] string User;
156
157
160 [property] string Password;
161
162
167 [property] long ResultSetType;
168};
169
170
171}; }; }; };
172
173/*===========================================================================
174===========================================================================*/
175#endif
176
177/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XColumnLocate.idl
com::sun::star::container::XNameAccess
is used to access named objects within a container.
Definition: XNameAccess.idl:40
com::sun::star::sdbc::XColumnLocate
provides the possibility to find columns by their name.
Definition: XColumnLocate.idl:45
com::sun::star::sdbc::XParameters
is used for parameter setting, commonly implemented in conjunction with PreparedStatements.
Definition: XParameters.idl:77
com::sun::star::sdbc::XRowSet
enhances the functionality of a result set.
Definition: XRowSet.idl:43
com
Definition: Accessible.idl:22
ResultSet.idl
com::sun::star::sdbc::ResultSet
provides access to a table of data.
Definition: ResultSet.idl:87
com::sun::star::sdbc::RowSet
is a client side ResultSet, which combines the characteristics of a com::sun::star::sdbc::Statement a...
Definition: RowSet.idl:58
com::sun::star::sdbc::RowSet::ResultSetType
long ResultSetType
determine the result set type.
Definition: RowSet.idl:167
com::sun::star::sdbc::RowSet::TypeMap
com::sun::star::container::XNameAccess TypeMap
is the type map that will be used for the custom mapping of SQL structured types and distinct types.
Definition: RowSet.idl:99
com::sun::star::sdbc::RowSet::Command
string Command
is the command which should be executed.
Definition: RowSet.idl:87
com::sun::star::sdbc::RowSet::MaxRows
long MaxRows
retrieves the maximum number of rows that a ResultSet can contain.
Definition: RowSet.idl:150
com::sun::star::sdbc::RowSet::QueryTimeOut
long QueryTimeOut
retrieves the number of seconds the driver will wait for a Statement to execute.
Definition: RowSet.idl:116
com::sun::star::sdbc::RowSet::Password
string Password
determines the user for whom to open the connection.
Definition: RowSet.idl:160
com::sun::star::sdbc::RowSet::User
string User
determines the user for whom to open the connection.
Definition: RowSet.idl:155
com::sun::star::sdbc::RowSet::EscapeProcessing
boolean EscapeProcessing
returns if escape processing is on or off.
Definition: RowSet.idl:107
com::sun::star::sdbc::RowSet::TransactionIsolation
long TransactionIsolation
indicates the transaction isolation level, which should be used for the connection.
Definition: RowSet.idl:93
com::sun::star::sdbc::RowSet::DataSourceName
string DataSourceName
is the name of a named datasource to use.
Definition: RowSet.idl:73
com::sun::star::sdbc::RowSet::MaxFieldSize
long MaxFieldSize
returns the maximum number of bytes allowed for any column value.
Definition: RowSet.idl:142
com::sun::star::sdbc::RowSet::URL
string URL
is the connection URL.
Definition: RowSet.idl:82