xref: /trunk/main/offapi/com/sun/star/sdbc/XMultipleResults.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_sdbc_XMultipleResults_idl__
#define __com_sun_star_sdbc_XMultipleResults_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sdbc_SQLException_idl__
#include <com/sun/star/sdbc/SQLException.idl>
#endif

 module com {  module sun {  module star {  module sdbc {

 published interface XResultSet;


/** is used for inspecting multiple results produced by the execution of a
    SQL statement.


    <p>
    Under some (uncommon) situations a single SQL statement may return
    multiple result sets and/or update counts.  Normally you can ignore
    this unless you are (1) executing a stored procedure that you know may
    return multiple results or (2) you are dynamically executing an
    unknown SQL string. The methods
    <member scope="com::sun::star::sdbc">XMultipleResults::getMoreResults()</member>
    ,
    <member scope="com::sun::star::sdbc">XMultipleResults::getResultSet()</member>
    and
    <member scope="com::sun::star::sdbc">XMultipleResults::getUpdateCount()</member>
    let you navigate through multiple results.

    </p>
    @see com::sun::star::sdbc::XStatement
     @see com::sun::star::sdbc::XPreparedStatement
 */
published interface XMultipleResults: com::sun::star::uno::XInterface
{

    /** returns the current result as a
        <type scope="com::sun::star::sdbc">ResultSet</type>
        object.
        This method should be called only once per result.
        @returns
            the ResultSet object
        @throws SQLException
            if a database access error occurs.
     */
    XResultSet getResultSet() raises (SQLException);
    //-------------------------------------------------------------------------

    /** returns the current result as an update count.


        <p>
        If the result is a ResultSet or there are no more results, -1
        is returned. This method should be called only once per result.
        </p>
        @returns
            the current result as an update count.
        @throws SQLException
            if a database access error occurs.
     */
    long getUpdateCount() raises (SQLException);
    //-------------------------------------------------------------------------

    /** moves to a Statement's next result. It returns <TRUE/> if
        this result is a ResultSet.  This method also implicitly
        closes any current ResultSet obtained with getResultSet.

        <p>
        There are no more results when <code>(!getMoreResults() &amp;amp;&amp;amp;
        getUpdateCount() == -1)</code>.

        </p>
        @returns
            <TRUE/> if there exists more ResultSet objects
        @throws SQLException
            if a database access error occurs.
     */
    boolean getMoreResults() raises (SQLException);
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif