From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- offapi/com/sun/star/sdbc/XClob.idl | 189 +++++++++++++++++++++++++++++++++++++ 1 file changed, 189 insertions(+) create mode 100644 offapi/com/sun/star/sdbc/XClob.idl (limited to 'offapi/com/sun/star/sdbc/XClob.idl') diff --git a/offapi/com/sun/star/sdbc/XClob.idl b/offapi/com/sun/star/sdbc/XClob.idl new file mode 100644 index 000000000..045dfc981 --- /dev/null +++ b/offapi/com/sun/star/sdbc/XClob.idl @@ -0,0 +1,189 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_sdbc_XClob_idl__ +#define __com_sun_star_sdbc_XClob_idl__ + +#include + + module com { module sun { module star { module io { + published interface XInputStream; +};};};}; + +#include + + module com { module sun { module star { module sdbc { + + +/** is the mapping for the SQL + CLOB + type. + + +

+ A SQL + CLOB + is a built-in type + that stores a Character Large Object as a column value in a row of + a database table. + The driver implements a + Clob + object using a SQL + locator(CLOB) + , which means that a + Clob + object + contains a logical pointer to the SQL + CLOB + data rather than + the data itself. A + Clob + object is valid for the duration + of the transaction in which it was created. +

+

+ The + Clob + interface provides methods for getting the + length of a SQL + CLOB + (Character Large Object) value, + for materializing a + CLOB + value on the client, and for + searching for a substring or + CLOB + object within a + CLOB + value. +

+

+ Methods in the interfaces + com::sun::star::sdbc::XResultSet + , + and + com::sun::star::sdbc::XPreparedStatement + , such as + getClob + and + setClob + allow a programmer to access the SQL CLOB. +

+ */ +published interface XClob: com::sun::star::uno::XInterface +{ + + /** returns the number of characters in the + CLOB + value + designated by this + Clob + object. + @returns + the length of the CLOB object + @throws SQLException + if a database access error occurs. + */ + hyper length() raises (SQLException); + + + /** returns a copy of the specified substring in the + Clob + value + designated by this + Clob + object. + + +

+ The substring begins at position pos and has up + to + length + consecutive characters. +

+ @param pos + the starting position, 1-based + @param length + the length of the substring + @returns + the substring + @throws SQLException + if a database access error occurs. + */ + string getSubString([in]hyper pos, [in]long length) raises (SQLException); + + + /** gets the + Clob + contents as a stream. + @returns + the stream + @throws SQLException + if a database access error occurs. + */ + com::sun::star::io::XInputStream getCharacterStream() raises (SQLException); + + + /** determines the character position at which the specified substring + searchstr + appears in the + Clob. + The search begins at position start. + + @param searchstr + the string to search + @param start + the starting position + @returns + the length of the CLOB object + @throws SQLException + if a database access error occurs. + */ + hyper position([in]string searchstr, [in]long start) + raises (SQLException); + + + /** determines the position at which the specified + Clob + object + pattern + appears in this + Clob + object. + The search begins at position start. + @param pattern + the CLOB to search + @param start + the starting position + @returns + the position of the CLOB inside + @throws SQLException + if a database access error occurs. + */ + hyper positionOfClob([in]XClob pattern, [in]hyper start) + raises (SQLException); +}; + + +}; }; }; }; + +/*=========================================================================== +===========================================================================*/ +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3