IResultSet.java

/* $Id: IResultSet.java 988245 2010-08-23 18:39:35Z kwright $ */

/**
* 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.
*/
package org.apache.manifoldcf.core.interfaces;

import java.util.*;

/** This interface represents a resultset.  Resultsets are immutable through this interface,
* and are accessed by row.
*/
public interface IResultSet
{
  public static final String _rcsid = "@(#)$Id: IResultSet.java 988245 2010-08-23 18:39:35Z kwright $";

  /** Get a specific row in the resultset.
  *@param rowNumber is the number of the row.
  *@return the immutable row description, or null if there is no such row.
  */
  public IResultRow getRow(int rowNumber);

  /** Get the number of rows in this resultset.
  *@return the number of rows the resultset contains.
  */
  public int getRowCount();

  /** Get an array of all the rows.
  * This method is NOT preferred because it requires a new
  * array object to be constructed.
  *@return the array.
  */
  public IResultRow[] getRows();
}