<?php
// Own namespace
namespace Org\Mxchange\CoreFramework\Criteria\Storing;

// Import framework stuff
use Org\Mxchange\CoreFramework\Criteria\Criteria;

/**
 * An interface for storeable data sets
 *
 * @author		Roland Haeder <webmaster@shipsimu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.shipsimu.org
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
interface StoreableCriteria extends Criteria {
	/**
	 * Setter for table name
	 *
	 * @param	$tableName	Name of the table to set
	 * @return	void
	 */
	function setTableName ($tableName);

	/**
	 * Getter for table name
	 *
	 * @return	$tableName	Name of the table to set
	 */
	function getTableName ();

	/**
	 * Setter for unique key
	 *
	 * @param	$uniqueKey	Column to use as unique key
	 * @return	void
	 */
	function setUniqueKey ($uniqueKey);

	/**
	 * Getter for unique key
	 *
	 * @return	$uniqueKey	Column to use as unique key
	 */
	function getUniqueKey ();

	/**
	 * Getter for unique key value
	 *
	 * @return	$uniqueValue	Value of the unique key
	 */
	function getUniqueValue ();

	/**
	 * Getter for primary key or unique key if not set
	 *
	 * @return	$primaryKey		Primary key or unique key if not set
	 */
	function getPrimaryKey ();

	/**
	 * Setter for primary key
	 *
	 * @param	$primaryKey		Primary key to set
	 * @return	void
	 */
	function setPrimaryKey ($primaryKey);

	/**
	 * Setter for primary key array
	 *
	 * @param	$primaryKeys	Primary key array to set
	 * @return	void
	 */
	function setPrimaryKeyCombined (array $primaryKeys);

	/**
	 * Getter for primary keys
	 *
	 * @return	$primaryKeys	Primary key array
	 */
	function getPrimaryKeys ();

}