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

LibreOffice LibreOffice 7.3 SDK API Reference

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#ifndef __com_sun_star_sdbc_XParameters_idl__
20#define __com_sun_star_sdbc_XParameters_idl__
21
22#include <com/sun/star/uno/XInterface.idl>
23
24#include <com/sun/star/util/Date.idl>
25
26#include <com/sun/star/util/DateTime.idl>
27
28#include <com/sun/star/util/Time.idl>
29
30 module com { module sun { module star { module io {
31 published interface XInputStream;
32};};};};
33
34#include <com/sun/star/sdbc/SQLException.idl>
35
36 module com { module sun { module star { module sdbc {
37
38 published interface XRef;
39 published interface XArray;
40 published interface XBlob;
41 published interface XClob;
42
43
76published interface XParameters: com::sun::star::uno::XInterface
77{
78
81 void setNull([in]long parameterIndex,
82 [in]long sqlType) raises (SQLException);
83
113 void setObjectNull([in]long parameterIndex,
114 [in]long sqlType,
115 [in]string typeName) raises (SQLException);
116
126 void setBoolean([in]long parameterIndex, [in]boolean x)
127 raises (SQLException);
128
138 void setByte([in]long parameterIndex, [in]byte x) raises (SQLException);
139
149 void setShort([in]long parameterIndex, [in]short x) raises (SQLException);
150
160 void setInt([in]long parameterIndex, [in]long x) raises (SQLException);
161
171 void setLong([in]long parameterIndex, [in]hyper x) raises (SQLException);
172
182 void setFloat([in]long parameterIndex, [in]float x) raises (SQLException);
183
193 void setDouble([in]long parameterIndex, [in]double x) raises (SQLException);
194
206 void setString([in]long parameterIndex, [in]string x) raises (SQLException);
207
219 void setBytes([in]long parameterIndex, [in]sequence<byte> x)
220 raises (SQLException);
221
231 void setDate([in]long parameterIndex, [in]com::sun::star::util::Date x)
232 raises (SQLException);
233
243 void setTime([in]long parameterIndex, [in]com::sun::star::util::Time x)
244 raises (SQLException);
245
256 void setTimestamp([in]long parameterIndex,
257 [in]com::sun::star::util::DateTime x) raises (SQLException);
258
274 void setBinaryStream([in]long parameterIndex,
275 [in]com::sun::star::io::XInputStream x,
276 [in]long length) raises (SQLException);
277
293 void setCharacterStream([in]long parameterIndex,
294 [in]com::sun::star::io::XInputStream x,
295 [in]long length) raises (SQLException);
296
319 void setObject([in]long parameterIndex, [in]any x)
320 raises (SQLException);
321
355 void setObjectWithInfo([in]long parameterIndex,
356 [in]any x, [in]long targetSqlType, [in]long scale)
357 raises (SQLException);
358
367 void setRef ([in]long parameterIndex, [in]XRef x) raises (SQLException);
368
377 void setBlob ([in]long parameterIndex, [in]XBlob x) raises (SQLException);
378
387 void setClob ([in]long parameterIndex, [in]XClob x) raises (SQLException);
388
397 void setArray ([in]long parameterIndex, [in]XArray x) raises (SQLException);
398
399
412 void clearParameters() raises (SQLException);
413};
414
415
416}; }; }; };
417
418/*===========================================================================
419===========================================================================*/
420#endif
421
422/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SQLException.idl
XInterface.idl
com::sun::star::sdbc::SQLException
is an exception that provides information on a database access error.
Definition: SQLException.idl:45
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:38
com::sun::star::sdbc::XArray
is used for mapping the SQL type com::sun::star::sdbc::DataType::ARRAY.
Definition: XArray.idl:42
com::sun::star::sdbc::XBlob
is the representation (mapping) of an SQL BLOB.
Definition: XBlob.idl:93
com::sun::star::sdbc::XClob
is the mapping for the SQL CLOB type.
Definition: XClob.idl:89
com::sun::star::sdbc::XParameters
is used for parameter setting, commonly implemented in conjunction with PreparedStatements.
Definition: XParameters.idl:77
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:35
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Accessible.idl:22
Date.idl
com::sun::star::util::DateTime
represents a combined date+time value.
Definition: DateTime.idl:29
com::sun::star::util::Date
represents a date value.
Definition: Date.idl:31
com::sun::star::util::Time
represents a time value.
Definition: Time.idl:29
DateTime.idl
Time.idl