diff options
Diffstat (limited to 'offapi/com/sun/star/sdbc/ResultSet.idl')
| -rw-r--r-- | offapi/com/sun/star/sdbc/ResultSet.idl | 243 |
1 files changed, 0 insertions, 243 deletions
diff --git a/offapi/com/sun/star/sdbc/ResultSet.idl b/offapi/com/sun/star/sdbc/ResultSet.idl deleted file mode 100644 index 75723a8f4..000000000 --- a/offapi/com/sun/star/sdbc/ResultSet.idl +++ /dev/null @@ -1,243 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ -#ifndef __com_sun_star_sdbc_ResultSet_idl__ -#define __com_sun_star_sdbc_ResultSet_idl__ - -#include <com/sun/star/lang/XComponent.idl> - -#include <com/sun/star/beans/XPropertySet.idl> - -#include <com/sun/star/util/XCancellable.idl> - - module com { module sun { module star { module sdbc { - - published interface XStatement; - published interface XRow; - published interface XRowUpdate; - published interface XResultSet; - published interface XResultSetUpdate; - published interface XResultSetMetaDataSupplier; - published interface XWarningsSupplier; - published interface XColumnLocate; - published interface XCloseable; - - -/** provides access to a table of data. A ResultSet - object is usually generated by executing a Statement. - - - - <p> - A ResultSet maintains a cursor pointing to its current row of - data. Initially the cursor is positioned before the first row. - The "next" method moves the cursor to the next row. - </p> - <p> - The getXXX methods retrieve column values for the current - row. You can retrieve values using either the index number of the - column. Columns are numbered from 1. - </p> - <p> - For maximum portability, ResultSet columns within each row should be - read in left-to-right order and each column should be read only once. - </p> - <p> - For the getXXX methods, the SDBC driver attempts to convert the - underlying data to the specified type and returns a suitable - value. - </p> - <p> - Column names used as input to the findColumn method are case - insensitive. When several columns have the same name, then the value - of the first matching column will be returned. The column name option is - designed to be used when column names are used in the SQL - query. For columns that are NOT explicitly named in the query, it - is best to use column numbers. If column names are used, there is - no way for the programmer to guarantee that they actually refer to - the intended columns. - </p> - <p> - A ResultSet is automatically closed (disposed) by the Statement that - generated it when that Statement is closed, re-executed, or used - to retrieve the next result from a sequence of multiple results. - </p> - <p> - The number, types, and properties of a ResultSet's columns are - provided by the ResultSetMetaData object returned by the getMetaData - method. - </p> - */ -published service ResultSet -{ - - /** optional for implementation; controls the releasing of resources - and the notification of registered listeners. - */ - [optional] interface com::sun::star::lang::XComponent; - - - /** freeing all resources of a result set. - - <p> - The creating statement will still be open after disposing. - </p> - - <p> - This interface is mandatory only for JDBC conformance, - otherwise it is optional. - </p> - */ - [optional] interface XCloseable; - - // gives access to the properties. - interface com::sun::star::beans::XPropertySet; - - - /** controls the chaining of warnings, which may occur on every call - to the connected database. - - <p> - Chained warnings from previous calls will be cleared before processing a new call. - </p> - - <p> - This interface is mandatory only for JDBC conformance, otherwise it is optional. - </p> - */ - [optional] interface XWarningsSupplier; - - - /** provides the access to the result set description. - */ - interface XResultSetMetaDataSupplier; - - - /** is the interface for navigating on the rows on a result set. - */ - interface XResultSet; - - - /** is the interface for updating row data to the database. - - <p> - The implementation is optional. - </p> - */ - [optional] interface XResultSetUpdate; - - - /** is the interface for accessing the data of the current row. - */ - interface XRow; - - - /** is used for locating a column by it's name. - */ - interface XColumnLocate; - - - /** is the interface for updating the data of the current row. - - <p> - The implementation is optional. - </p> - */ - [optional] interface XRowUpdate; - - - /** defines the SQL cursor name that will be used by subsequent Statement - <code>execute</code> - methods. - - - <p> - This name can then be used in SQL positioned update/delete statements to - identify the current row in the ResultSet generated by this statement. If - the database doesn't support positioned update/delete, this property is - a noop. To insure that a cursor has the proper isolation level to support - updates, the cursor's SELECT statement should be of the form - "select for update ...". If the "for update" phrase is omitted, - positioned updates may fail. - </p> - <p> - <b> - Note: - </b> - By definition, positioned update/delete - execution must be done by a different Statement than the one - which generated the ResultSet being used for positioning. Also, - cursor names must be unique within a connection. - </p> - */ - [optional, readonly, property] string CursorName; - - - /** retrieves the result set concurrency. - - @see com::sun::star::sdbc::ResultSetConcurrency - */ - [readonly, property] long ResultSetConcurrency; - - - /** determines the result set type. - - @see com::sun::star::sdbc::ResultSetType - */ - [readonly, property] long ResultSetType; - - - /** retrieves the direction for fetching rows from database tables - that is the default for result sets generated from this - <type scope="com::sun::star::sdbcx">Statement</type> - object. - <br/> - If this <code>Statement</code> object has not set a fetch direction, - the return value is implementation-specific. - */ - [property] long FetchDirection; - - - /** retrieves the number of result set rows that is the default fetch size - for result sets generated from this - <type scope="com::sun::star::sdbcx">Statement</type> - object. - <br/> - If this - <type scope="com::sun::star::sdbcx">Statement</type> - object has not set a fetch size, - the return value is implementation-specific. - */ - [property] long FetchSize; -}; - -//============================================================================= - -}; }; }; }; - -/*=========================================================================== -===========================================================================*/ -#endif |