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