1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_sdb_XColumn_idl__ 24cdf0e10cSrcweir#define __com_sun_star_sdb_XColumn_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_sdbc_SQLException_idl__ 31cdf0e10cSrcweir#include <com/sun/star/sdbc/SQLException.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_util_Date_idl__ 35cdf0e10cSrcweir#include <com/sun/star/util/Date.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_util_DateTime_idl__ 39cdf0e10cSrcweir#include <com/sun/star/util/DateTime.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_util_Time_idl__ 43cdf0e10cSrcweir#include <com/sun/star/util/Time.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir module com { module sun { module star { module io { 47cdf0e10cSrcweir published interface XInputStream; 48cdf0e10cSrcweir};};};}; 49cdf0e10cSrcweir 50cdf0e10cSrcweir module com { module sun { module star { module container { 51cdf0e10cSrcweir published interface XNameAccess; 52cdf0e10cSrcweir};};};}; 53cdf0e10cSrcweir 54cdf0e10cSrcweir module com { module sun { module star { module sdbc { 55cdf0e10cSrcweir published interface XRef; 56cdf0e10cSrcweir published interface XArray; 57cdf0e10cSrcweir published interface XBlob; 58cdf0e10cSrcweir published interface XClob; 59cdf0e10cSrcweir};};};}; 60cdf0e10cSrcweir 61cdf0e10cSrcweir module com { module sun { module star { module sdb { 62cdf0e10cSrcweir 63cdf0e10cSrcweir 64cdf0e10cSrcweir/** is used to access data which is collected in a row. 65cdf0e10cSrcweir */ 66cdf0e10cSrcweirpublished interface XColumn: com::sun::star::uno::XInterface 67cdf0e10cSrcweir{ 68cdf0e10cSrcweir //------------------------------------------------------------------------- 69cdf0e10cSrcweir 70cdf0e10cSrcweir /** reports whether the last column read had a value of SQL NULL. 71cdf0e10cSrcweir Note that you must first call getXXX on a column to try to read 72cdf0e10cSrcweir its value and then call 73cdf0e10cSrcweir <code>wasNull()</code> 74cdf0e10cSrcweir to see if the value read was SQL NULL. 75cdf0e10cSrcweir @returns 76cdf0e10cSrcweir <TRUE/> if so 77cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 78cdf0e10cSrcweir if a database access error occurs. 79cdf0e10cSrcweir */ 80cdf0e10cSrcweir boolean wasNull() raises (com::sun::star::sdbc::SQLException); 81cdf0e10cSrcweir //------------------------------------------------------------------------- 82cdf0e10cSrcweir 83cdf0e10cSrcweir /** gets the value of a column in the current row as a String. 84cdf0e10cSrcweir @returns 85cdf0e10cSrcweir the column value 86cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 87cdf0e10cSrcweir if a database access error occurs. 88cdf0e10cSrcweir */ 89cdf0e10cSrcweir string getString() raises (com::sun::star::sdbc::SQLException); 90cdf0e10cSrcweir //------------------------------------------------------------------------- 91cdf0e10cSrcweir 92cdf0e10cSrcweir /** gets the value of a column in the current row as boolean. 93cdf0e10cSrcweir @returns 94cdf0e10cSrcweir the column value 95cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 96cdf0e10cSrcweir if a database access error occurs. 97cdf0e10cSrcweir */ 98cdf0e10cSrcweir boolean getBoolean() raises (com::sun::star::sdbc::SQLException); 99cdf0e10cSrcweir //------------------------------------------------------------------------- 100cdf0e10cSrcweir 101cdf0e10cSrcweir /** gets the value of a column in the current row as a byte. 102cdf0e10cSrcweir @returns 103cdf0e10cSrcweir the column value 104cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 105cdf0e10cSrcweir if a database access error occurs. 106cdf0e10cSrcweir */ 107cdf0e10cSrcweir byte getByte() raises (com::sun::star::sdbc::SQLException); 108cdf0e10cSrcweir //------------------------------------------------------------------------- 109cdf0e10cSrcweir 110cdf0e10cSrcweir /** gets the value of a column in the current row as a short. 111cdf0e10cSrcweir @returns 112cdf0e10cSrcweir the column value 113cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 114cdf0e10cSrcweir if a database access error occurs. 115cdf0e10cSrcweir */ 116cdf0e10cSrcweir short getShort() raises (com::sun::star::sdbc::SQLException); 117cdf0e10cSrcweir //------------------------------------------------------------------------- 118cdf0e10cSrcweir 119cdf0e10cSrcweir /** gets the value of a column in the current row as a long. 120cdf0e10cSrcweir @returns 121cdf0e10cSrcweir the column value 122cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 123cdf0e10cSrcweir if a database access error occurs. 124cdf0e10cSrcweir */ 125cdf0e10cSrcweir long getInt() raises (com::sun::star::sdbc::SQLException); 126cdf0e10cSrcweir //------------------------------------------------------------------------- 127cdf0e10cSrcweir 128cdf0e10cSrcweir /** gets the value of a column in the current row as a hyper. 129cdf0e10cSrcweir @returns 130cdf0e10cSrcweir the column value 131cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 132cdf0e10cSrcweir if a database access error occurs. 133cdf0e10cSrcweir */ 134cdf0e10cSrcweir hyper getLong() raises (com::sun::star::sdbc::SQLException); 135cdf0e10cSrcweir //------------------------------------------------------------------------- 136cdf0e10cSrcweir 137cdf0e10cSrcweir /** gets the value of a column in the current row as a float. 138cdf0e10cSrcweir @returns 139cdf0e10cSrcweir the column value 140cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 141cdf0e10cSrcweir if a database access error occurs. 142cdf0e10cSrcweir */ 143cdf0e10cSrcweir float getFloat() raises (com::sun::star::sdbc::SQLException); 144cdf0e10cSrcweir //------------------------------------------------------------------------- 145cdf0e10cSrcweir 146cdf0e10cSrcweir /** gets the value of a column in the current row as a double. 147cdf0e10cSrcweir @returns 148cdf0e10cSrcweir the column value 149cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 150cdf0e10cSrcweir if a database access error occurs. 151cdf0e10cSrcweir */ 152cdf0e10cSrcweir double getDouble() raises (com::sun::star::sdbc::SQLException); 153cdf0e10cSrcweir //------------------------------------------------------------------------- 154cdf0e10cSrcweir 155cdf0e10cSrcweir /** gets the value of a column in the current row as a byte array. 156cdf0e10cSrcweir The bytes represent the raw values returned by the driver. 157cdf0e10cSrcweir @returns the column value; 158cdf0e10cSrcweir if the value is SQL NULL, the result is empty. 159cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 160cdf0e10cSrcweir if a database access error occurs. 161cdf0e10cSrcweir */ 162cdf0e10cSrcweir sequence<byte> getBytes() raises (com::sun::star::sdbc::SQLException); 163cdf0e10cSrcweir //------------------------------------------------------------------------- 164cdf0e10cSrcweir 165cdf0e10cSrcweir /** gets the value of a column in the current row as a date object. 166cdf0e10cSrcweir @returns 167cdf0e10cSrcweir the column value 168cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 169cdf0e10cSrcweir if a database access error occurs. 170cdf0e10cSrcweir */ 171cdf0e10cSrcweir com::sun::star::util::Date getDate() 172cdf0e10cSrcweir raises (com::sun::star::sdbc::SQLException); 173cdf0e10cSrcweir //------------------------------------------------------------------------- 174cdf0e10cSrcweir 175cdf0e10cSrcweir /** gets the value of a column in the current row as a time object. 176cdf0e10cSrcweir @returns 177cdf0e10cSrcweir the column value 178cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 179cdf0e10cSrcweir if a database access error occurs. 180cdf0e10cSrcweir */ 181cdf0e10cSrcweir com::sun::star::util::Time getTime() 182cdf0e10cSrcweir raises (com::sun::star::sdbc::SQLException); 183cdf0e10cSrcweir //------------------------------------------------------------------------- 184cdf0e10cSrcweir 185cdf0e10cSrcweir /** gets the value of a column in the current row as a datetime object. 186cdf0e10cSrcweir @returns 187cdf0e10cSrcweir the column value 188cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 189cdf0e10cSrcweir if a database access error occurs. 190cdf0e10cSrcweir */ 191cdf0e10cSrcweir com::sun::star::util::DateTime getTimestamp() 192cdf0e10cSrcweir raises (com::sun::star::sdbc::SQLException); 193cdf0e10cSrcweir //------------------------------------------------------------------------- 194cdf0e10cSrcweir 195cdf0e10cSrcweir /** gets the value of a column in the current row as a stream of 196cdf0e10cSrcweir uninterpreted bytes. The value can then be read in chunks from the 197cdf0e10cSrcweir stream. This method is particularly suitable for retrieving large 198cdf0e10cSrcweir LONGVARBINARY or LONGVARCHAR values. 199cdf0e10cSrcweir 200cdf0e10cSrcweir 201cdf0e10cSrcweir <p> 202cdf0e10cSrcweir <b>Note:</b> All the data in the returned stream must be 203cdf0e10cSrcweir read prior to getting the value of any other column. The next 204cdf0e10cSrcweir call to a get method implicitly closes the stream. Also, a 205cdf0e10cSrcweir stream may return 0 when the method 206cdf0e10cSrcweir <member scope="com::sun::star::io">XInputStream::available()</member> 207cdf0e10cSrcweir is called whether there is data available or not. 208cdf0e10cSrcweir </p> 209cdf0e10cSrcweir @returns 210cdf0e10cSrcweir the column value 211cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 212cdf0e10cSrcweir if a database access error occurs. 213cdf0e10cSrcweir */ 214cdf0e10cSrcweir com::sun::star::io::XInputStream getBinaryStream() 215cdf0e10cSrcweir raises (com::sun::star::sdbc::SQLException); 216cdf0e10cSrcweir //------------------------------------------------------------------------- 217cdf0e10cSrcweir 218cdf0e10cSrcweir /** gets the value of a column in the current row as a stream of 219cdf0e10cSrcweir uninterpreted bytes. The value can then be read in chunks from the 220cdf0e10cSrcweir stream. This method is particularly suitable for retrieving large 221cdf0e10cSrcweir LONGVARCHAR values. 222cdf0e10cSrcweir 223cdf0e10cSrcweir <p> 224cdf0e10cSrcweir <b>Note:</b> All the data in the returned stream must be 225cdf0e10cSrcweir read prior to getting the value of any other column. The next 226cdf0e10cSrcweir call to a get method implicitly closes the stream. Also, a 227cdf0e10cSrcweir stream may return 0 when the method 228cdf0e10cSrcweir <member scope="com::sun::star::io">XInputStream::available()</member> 229cdf0e10cSrcweir is called whether there is data available or not. 230cdf0e10cSrcweir </p> 231cdf0e10cSrcweir @returns 232cdf0e10cSrcweir the column value 233cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 234cdf0e10cSrcweir if a database access error occurs. 235cdf0e10cSrcweir */ 236cdf0e10cSrcweir com::sun::star::io::XInputStream getCharacterStream() 237cdf0e10cSrcweir raises (com::sun::star::sdbc::SQLException); 238cdf0e10cSrcweir //------------------------------------------------------------------------- 239cdf0e10cSrcweir 240cdf0e10cSrcweir /** @returns the value of a column in the current row as an object. 241cdf0e10cSrcweir This method uses the given 242cdf0e10cSrcweir <code>Map</code> 243cdf0e10cSrcweir object 244cdf0e10cSrcweir for the custom mapping of the SQL structure or distinct type 245cdf0e10cSrcweir that is being retrieved. 246cdf0e10cSrcweir @param typeMap 247cdf0e10cSrcweir the type map is used to fetch the correct type 248cdf0e10cSrcweir @returns 249cdf0e10cSrcweir the column value 250cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 251cdf0e10cSrcweir if a database access error occurs. 252cdf0e10cSrcweir */ 253cdf0e10cSrcweir any getObject([in]com::sun::star::container::XNameAccess typeMap) 254cdf0e10cSrcweir raises (com::sun::star::sdbc::SQLException); 255cdf0e10cSrcweir //------------------------------------------------------------------------- 256cdf0e10cSrcweir 257cdf0e10cSrcweir /** gets a REF(<structured-type>) column value from the current row. 258cdf0e10cSrcweir 259cdf0e10cSrcweir @returns 260cdf0e10cSrcweir the column value 261cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 262cdf0e10cSrcweir if a database access error occurs. 263cdf0e10cSrcweir */ 264cdf0e10cSrcweir com::sun::star::sdbc::XRef getRef() raises (com::sun::star::sdbc::SQLException); 265cdf0e10cSrcweir //------------------------------------------------------------------------- 266cdf0e10cSrcweir 267cdf0e10cSrcweir /** gets a BLOB (Binary Large OBject) value in the current row. 268cdf0e10cSrcweir @returns 269cdf0e10cSrcweir the column value 270cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 271cdf0e10cSrcweir if a database access error occurs. 272cdf0e10cSrcweir */ 273cdf0e10cSrcweir com::sun::star::sdbc::XBlob getBlob() raises (com::sun::star::sdbc::SQLException); 274cdf0e10cSrcweir //------------------------------------------------------------------------- 275cdf0e10cSrcweir 276cdf0e10cSrcweir /** gets a CLOB value in the current row of this <code>ResultSet</code> object. 277cdf0e10cSrcweir @returns 278cdf0e10cSrcweir the column value 279cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 280cdf0e10cSrcweir if a database access error occurs. 281cdf0e10cSrcweir */ 282cdf0e10cSrcweir com::sun::star::sdbc::XClob getClob() raises (com::sun::star::sdbc::SQLException); 283cdf0e10cSrcweir //------------------------------------------------------------------------- 284cdf0e10cSrcweir 285cdf0e10cSrcweir /** gets a SQL ARRAY value from the current row. 286cdf0e10cSrcweir @returns 287cdf0e10cSrcweir the column value 288cdf0e10cSrcweir @throws com::sun::star::sdbc::SQLException 289cdf0e10cSrcweir if a database access error occurs. 290cdf0e10cSrcweir */ 291cdf0e10cSrcweir com::sun::star::sdbc::XArray getArray() raises (com::sun::star::sdbc::SQLException); 292cdf0e10cSrcweir}; 293cdf0e10cSrcweir 294cdf0e10cSrcweir//============================================================================= 295cdf0e10cSrcweir 296cdf0e10cSrcweir}; }; }; }; 297cdf0e10cSrcweir 298cdf0e10cSrcweir/*=========================================================================== 299cdf0e10cSrcweir===========================================================================*/ 300cdf0e10cSrcweir#endif 301