package com.dbxml.db.core.data;

/*
 * dbXML - Native XML Database
 * Copyright (C) 1999-2004  The dbXML Group, L.L.C.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * $Id: RecordSet.java,v 1.2 2004/02/12 00:17:57 bradford Exp $
 */

import com.dbxml.db.core.DBException;

/**
 * RecordSet is an interface for iterating over a set of Records.
 * It is almost always returned by Filers.
 */

public interface RecordSet {
   /**
    * hasMoreRecords returns whether or not there are any Records
    * left in the set.
    *
    * @return Whether there are any more Records
    */
   boolean hasMoreRecords() throws DBException;

   /**
    * getNextRecord returns the next Record in the set.
    *
    * @return The next Record
    */
   Record getNextRecord() throws DBException;

   /**
    * getNextKey returns the next Record's Key, and skips the
    * RecordSet ahead to the next Record.
    *
    * @return The next Key
    */
   Key getNextKey() throws DBException;

   /**
    * getNextValue returns the next Record's Value, and skips the
    * RecordSet ahead to the next Record.
    *
    * @return The next Value
    */
   Value getNextValue() throws DBException;
}
