ResultSetRowFetcher.java example

Explorer
Dirmi-master
/*
 *  Copyright 2007-2010 Brian S O'Neill
 *
 *  Licensed 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.
 */

package org.cojen.dirmi.jdbc;

import java.rmi.Remote;
import java.rmi.RemoteException;

import java.sql.SQLException;
import java.sql.SQLWarning;

import org.cojen.dirmi.Asynchronous;
import org.cojen.dirmi.Pipe;

/**
 * 
 *
 * @author Brian S O'Neill
 */
public interface ResultSetRowFetcher extends Remote {
    /**
     * Fetches rows from result set, which might supply less than the requested
     * maximum amount.
     *
     * @return null if no rows left
     */
    @Asynchronous
    Pipe fetch(Pipe pipe) throws RemoteException;

    SQLWarning getWarnings() throws RemoteException, SQLException;

    void clearWarnings() throws RemoteException, SQLException;

    String getCursorName() throws RemoteException, SQLException;

    /**
     * Result set is automatically closed when all results are fetched, but
     * this can be called to close early.
     */
    @Asynchronous
    void close() throws RemoteException;
}