offapi/com/sun/star/sdbc/XClob.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 io {
  21  published interface XInputStream;
  22 };};};};
  23
  24  module com {  module sun {  module star {  module sdbc {
  25
  26
  27 /** is the mapping for the SQL
  28     <code>CLOB</code>
  29     type.
  30
  31
  32     <p>
  33     A SQL
  34     <code>CLOB</code>
  35     is a built-in type
  36     that stores a Character Large Object as a column value in a row of
  37     a database table.
  38     The driver implements a
  39     <code>Clob</code>
  40     object using a SQL
  41     <code>locator(CLOB)</code>
  42     , which means that a
  43     <code>Clob</code>
  44     object
  45     contains a logical pointer to the SQL
  46     <code>CLOB</code>
  47     data rather than
  48     the data itself. A
  49     <code>Clob</code>
  50     object is valid for the duration
  51     of the transaction in which it was created.
  52     </p>
  53     <p>
  54     The
  55     <code>Clob</code>
  56     interface provides methods for getting the
  57     length of a SQL
  58     <code>CLOB</code>
  59     (Character Large Object) value,
  60     for materializing a
  61     <code>CLOB</code>
  62     value on the client, and for
  63     searching for a substring or
  64     <code>CLOB</code>
  65     object within a
  66     <code>CLOB</code>
  67     value.
  68     </p>
  69     <p>
  70     Methods in the interfaces
  71     com::sun::star::sdbc::XResultSet
  72     ,
  73     and
  74     com::sun::star::sdbc::XPreparedStatement
  75     , such as
  76     <code>getClob</code>
  77     and
  78     <code>setClob</code>
  79     allow a programmer to access the SQL <code>CLOB</code>.
  80     </p>
  81  */
  82 published interface XClob: com::sun::star::uno::XInterface
  83 {
  84
  85     /** returns the number of characters in the
  86         <code>CLOB</code>
  87         value
  88         designated by this
  89         <code>Clob</code>
  90         object.
  91         @returns
  92             the length of the CLOB object
  93         @throws SQLException
  94             if a database access error occurs.
  95      */
  96     hyper length() raises (SQLException);
  97
  98
  99     /** returns a copy of the specified substring in the
 100         <code>Clob</code>
 101         value
 102         designated by this
 103         <code>Clob</code>
 104         object.
 105
 106
 107         <p>
 108         The substring begins at position <code>pos</code> and has up
 109         to
 110         <code>length</code>
 111         consecutive characters.
 112         </p>
 113         @param pos
 114             the starting position, 1-based
 115         @param length
 116             the length of the substring
 117         @returns
 118             the substring
 119         @throws SQLException
 120             if a database access error occurs.
 121      */
 122     string getSubString([in]hyper pos, [in]long length) raises (SQLException);
 123
 124
 125     /** gets the
 126         <code>Clob</code>
 127         contents as a stream.
 128         @returns
 129             the stream
 130         @throws SQLException
 131             if a database access error occurs.
 132      */
 133     com::sun::star::io::XInputStream getCharacterStream() raises (SQLException);
 134
 135
 136     /** determines the character position at which the specified substring
 137         <code>searchstr</code>
 138         appears in the
 139         <code>Clob</code>.
 140         The search begins at position <code>start</code>.
 141
 142         @param searchstr
 143             the string to search
 144         @param start
 145             the starting position
 146         @returns
 147             the length of the CLOB object
 148         @throws SQLException
 149             if a database access error occurs.
 150      */
 151     hyper position([in]string searchstr, [in]long start)
 152         raises (SQLException);
 153
 154
 155     /** determines the position at which the specified
 156         <code>Clob</code>
 157         object
 158         <code>pattern</code>
 159         appears in this
 160         <code>Clob</code>
 161         object.
 162         The search begins at position <code>start</code>.
 163         @param pattern
 164             the CLOB to search
 165         @param start
 166             the starting position
 167         @returns
 168             the position of the CLOB inside
 169         @throws SQLException
 170             if a database access error occurs.
 171      */
 172     hyper positionOfClob([in]XClob pattern, [in]hyper start)
 173         raises (SQLException);
 174 };
 175
 176
 177 }; }; }; };
 178
 179 /*===========================================================================
 180 ===========================================================================*/
 181
 182 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */