LibreOffice: com/sun/star/sdbc/XParameters.idl Source File

LibreOffice LibreOffice 24.2 SDK API Reference

Loading...
Searching...
No Matches
XParameters.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
20 module com { module sun { module star { module io {
21 published interface XInputStream;
22};};};};
23
24 module com { module sun { module star { module sdbc {
25
26 published interface XRef;
27 published interface XArray;
28 published interface XBlob;
29 published interface XClob;
30
31
64published interface XParameters: com::sun::star::uno::XInterface
65{
66
69 void setNull([in]long parameterIndex,
70 [in]long sqlType) raises (SQLException);
71
101 void setObjectNull([in]long parameterIndex,
102 [in]long sqlType,
103 [in]string typeName) raises (SQLException);
104
114 void setBoolean([in]long parameterIndex, [in]boolean x)
115 raises (SQLException);
116
126 void setByte([in]long parameterIndex, [in]byte x) raises (SQLException);
127
137 void setShort([in]long parameterIndex, [in]short x) raises (SQLException);
138
148 void setInt([in]long parameterIndex, [in]long x) raises (SQLException);
149
159 void setLong([in]long parameterIndex, [in]hyper x) raises (SQLException);
160
170 void setFloat([in]long parameterIndex, [in]float x) raises (SQLException);
171
181 void setDouble([in]long parameterIndex, [in]double x) raises (SQLException);
182
194 void setString([in]long parameterIndex, [in]string x) raises (SQLException);
195
207 void setBytes([in]long parameterIndex, [in]sequence<byte> x)
208 raises (SQLException);
209
219 void setDate([in]long parameterIndex, [in]com::sun::star::util::Date x)
220 raises (SQLException);
221
231 void setTime([in]long parameterIndex, [in]com::sun::star::util::Time x)
232 raises (SQLException);
233
244 void setTimestamp([in]long parameterIndex,
245 [in]com::sun::star::util::DateTime x) raises (SQLException);
246
262 void setBinaryStream([in]long parameterIndex,
263 [in]com::sun::star::io::XInputStream x,
264 [in]long length) raises (SQLException);
265
281 void setCharacterStream([in]long parameterIndex,
282 [in]com::sun::star::io::XInputStream x,
283 [in]long length) raises (SQLException);
284
307 void setObject([in]long parameterIndex, [in]any x)
308 raises (SQLException);
309
343 void setObjectWithInfo([in]long parameterIndex,
344 [in]any x, [in]long targetSqlType, [in]long scale)
345 raises (SQLException);
346
355 void setRef ([in]long parameterIndex, [in]XRef x) raises (SQLException);
356
365 void setBlob ([in]long parameterIndex, [in]XBlob x) raises (SQLException);
366
375 void setClob ([in]long parameterIndex, [in]XClob x) raises (SQLException);
376
385 void setArray ([in]long parameterIndex, [in]XArray x) raises (SQLException);
386
387
400 void clearParameters() raises (SQLException);
401};
402
403
404}; }; }; };
405
406/*===========================================================================
407===========================================================================*/
408
409/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::sdbc::SQLException
is an exception that provides information on a database access error.
Definition SQLException.idl:41
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition XInputStream.idl:30
com::sun::star::sdbc::XArray
is used for mapping the SQL type com::sun::star::sdbc::DataType::ARRAY.
Definition XArray.idl:36
com::sun::star::sdbc::XBlob
is the representation (mapping) of an SQL BLOB.
Definition XBlob.idl:87
com::sun::star::sdbc::XClob
is the mapping for the SQL CLOB type.
Definition XClob.idl:83
com::sun::star::sdbc::XParameters
is used for parameter setting, commonly implemented in conjunction with PreparedStatements.
Definition XParameters.idl:65
com::sun::star::sdbc::XParameters::setBytes
void setBytes([in]long parameterIndex, [in]sequence< byte > x)
sets the designated parameter to a sequence of bytes.
com::sun::star::sdbc::XParameters::setCharacterStream
void setCharacterStream([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, [in]long length)
sets the designated parameter to the given input stream, which will have the specified number of byte...
com::sun::star::sdbc::XParameters::setTime
void setTime([in]long parameterIndex, [in]com::sun::star::util::Time x)
sets the designated parameter to a time value.
com::sun::star::sdbc::XParameters::setObject
void setObject([in]long parameterIndex, [in]any x)
sets the value of a parameter using an any.
com::sun::star::sdbc::XParameters::setArray
void setArray([in]long parameterIndex, [in]XArray x)
sets an Array parameter.
com::sun::star::sdbc::XParameters::setBinaryStream
void setBinaryStream([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, [in]long length)
sets the designated parameter to the given input stream, which will have the specified number of byte...
com::sun::star::sdbc::XParameters::setClob
void setClob([in]long parameterIndex, [in]XClob x)
sets a CLOB parameter.
com::sun::star::sdbc::XParameters::setBlob
void setBlob([in]long parameterIndex, [in]XBlob x)
sets a BLOB parameter.
com::sun::star::sdbc::XParameters::setTimestamp
void setTimestamp([in]long parameterIndex, [in]com::sun::star::util::DateTime x)
sets the designated parameter to a datetime value.
com::sun::star::sdbc::XParameters::setDouble
void setDouble([in]long parameterIndex, [in]double x)
sets the designated parameter to a double value.
com::sun::star::sdbc::XParameters::setRef
void setRef([in]long parameterIndex, [in]XRef x)
sets a REF(&lt;structured-type&gt;) parameter.
com::sun::star::sdbc::XParameters::setObjectNull
void setObjectNull([in]long parameterIndex, [in]long sqlType, [in]string typeName)
sets the designated parameter to SQL NULL.
com::sun::star::sdbc::XParameters::setNull
void setNull([in]long parameterIndex, [in]long sqlType)
sets the designated parameter to SQL NULL.
com::sun::star::sdbc::XParameters::clearParameters
void clearParameters()
clears the current parameter values immediately.
com::sun::star::sdbc::XParameters::setShort
void setShort([in]long parameterIndex, [in]short x)
sets the designated parameter to a short value.
com::sun::star::sdbc::XParameters::setLong
void setLong([in]long parameterIndex, [in]hyper x)
sets the designated parameter to a hyper value.
com::sun::star::sdbc::XParameters::setObjectWithInfo
void setObjectWithInfo([in]long parameterIndex, [in]any x, [in]long targetSqlType, [in]long scale)
set a value from the Datatype ANY for a parameter.
com::sun::star::sdbc::XParameters::setByte
void setByte([in]long parameterIndex, [in]byte x)
sets the designated parameter to a byte value.
com::sun::star::sdbc::XParameters::setDate
void setDate([in]long parameterIndex, [in]com::sun::star::util::Date x)
sets the designated parameter to a date value.
com::sun::star::sdbc::XParameters::setBoolean
void setBoolean([in]long parameterIndex, [in]boolean x)
sets the designated parameter to a boolean value.
com::sun::star::sdbc::XParameters::setFloat
void setFloat([in]long parameterIndex, [in]float x)
sets the designated parameter to a float value.
com::sun::star::sdbc::XParameters::setString
void setString([in]long parameterIndex, [in]string x)
sets the designated parameter to a string value.
com::sun::star::sdbc::XParameters::setInt
void setInt([in]long parameterIndex, [in]long x)
sets the designated parameter to a long value.
com::sun::star::sdbc::XRef
is the reference to a SQL structured type value in the database.
Definition XRef.idl:29
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition generated_idl_chapter_refs.idl:452
com
Definition Ambiguous.idl:20
com::sun::star::util::DateTime
represents a combined date+time value.
Definition DateTime.idl:27
com::sun::star::util::Date
represents a date value.
Definition Date.idl:29
com::sun::star::util::Time
represents a time value.
Definition Time.idl:27