<?php
/* $Id$ */
namespace Mammut\DB;

(defined('MAMMUT') && (basename(__FILE__) != basename($_SERVER['PHP_SELF']))) or die('ACCESS DENIED');

/**
 * A interface which defines fetch methods for database access
 *
 * @author Stefan Daurer <s.daurer@q-spot.org>
 * @package Mammut\DB
 */
interface iFetchable {

	/**
	 * Fetches the number of rows avaible.
	 * In cases where the number of rows is not avaible, this method will return -1.
	 * 
	 * @return int The size of the result set
	 */
	public function getRowCount();

	/**
	 * Fetches the next row as an numbered array.
	 *
	 * @return array The next row.
	 */
	public function fetchRow();

	/**
	 * Fetches all rows as an array of numbered arrays.
	 *
	 * @return array The row array.
	 */
	public function fetchRowList();

	/**
	 * Fetches the next row as an associative array.
	 *
	 * @return array The next row
	 */
	public function fetchArray();

	/**
	 * Fetches all rows as an array of associative arrays.
	 *
	 * @return array The row array.
	 */
	public function fetchArrayList();

	/**
	 * Fetches the next row as an object.
	 *
	 * @param string $class
	 *        	Optional class which should be used.
	 * @param array $param
	 *        	Parameters for the constructor.
	 * @return object The next row.
	 */
	public function fetchObject($class = false, $param = array());

	/**
	 * Fetches all rows as an array of row objects.
	 * 
	 * @param string $class
	 *        	Optional class which should be used.
	 * @param array $param
	 *        	Parameters for the constructor.
	 *        	
	 * @return object The object array.
	 */
	public function fetchObjectList($class = false, $param = array());
}