<?php
/* $Id$ */
namespace MCMS\Model;

(defined('MCMS') && (basename(__FILE__) != basename($_SERVER['PHP_SELF']))) or die('ACCESS DENIED');

/**
 * Historized model interface.
 *
 * Historized models remember who and when they where created, modified or deleted, and
 * who did it.
 * Deletion information is only avaible if the dataset is only marked as deleted in some
 * way.
 *
 * @package MCMS\Modeling
 * @author Stefan Daurer <sd@qdevzone.net>
 * @since 1.0.0.0
 */
interface iHistorized extends iModel {

	/**
	 * returns the dataset creation time as a uts timestamp
	 */
	public function getCreatedAt();

	public function setCreatedAt($timestamp);

	/**
	 * returns the user id of the user who created the dataset
	 */
	public function getCreatedById();

	public function setCreatedById($id);

	public function getCreatedByName();

	public function setCreatedByName($name);

	/**
	 * returns the dataset last modification time as a uts timestamp
	 */
	public function getModifiedAt();

	public function setModifiedAt($timestamp);

	/**
	 * returns the user id of the last user who modified the dataset
	 */
	public function getModifiedById();

	public function setModifiedById($id);

	public function getModifiedByName();

	public function setModifiedByName($name);

	/**
	 * returns the dataset deletion time as a uts timestamp (if possible)
	 */
	public function getDeletedAt();

	public function setDeletedAt($timestamp);

	/**
	 * returns the user id of the last user who deleted the dataset (if possible)
	 */
	public function getDeletedById();

	public function setDeletedById($id);

	public function getDeletedByName();

	public function setDeletedByName($name);
}