<?php namespace Cartalyst\Sentry\Throttling;
/**
 * Part of the Sentry package.
 *
 * NOTICE OF LICENSE
 *
 * Licensed under the 3-clause BSD License.
 *
 * This source file is subject to the 3-clause BSD License that is
 * bundled with this package in the LICENSE file.  It is also available at
 * the following URL: http://www.opensource.org/licenses/BSD-3-Clause
 *
 * @package    Sentry
 * @version    2.0.0
 * @author     Cartalyst LLC
 * @license    BSD License (3-clause)
 * @copyright  (c) 2011 - 2013, Cartalyst LLC
 * @link       http://cartalyst.com
 */

interface ThrottleInterface {

	/**
	 * Returns the associated user with the throttler.
	 *
	 * @return \Cartalyst\Sentry\Users\UserInterface
	 */
	public function getUser();

	/**
	 * Get the current amount of attempts.
	 *
	 * @return int
	 */
	public function getLoginAttempts();

	/**
	 * Add a new login attempt.
	 *
	 * @return void
	 */
	public function addLoginAttempt();

	/**
	 * Clear all login attempts
	 *
	 * @return void
	 */
	public function clearLoginAttempts();

	/**
	 * Suspend the user associated with the throttle
	 *
	 * @return void
	 */
	public function suspend();

	/**
	 * Unsuspend the user.
	 *
	 * @return void
	 */
	public function unsuspend();

	/**
	 * Check if the user is suspended.
	 *
	 * @return bool
	 */
	public function isSuspended();

	/**
	 * Ban the user.
	 *
	 * @return bool
	 */
	public function ban();

	/**
	 * Unban the user.
	 *
	 * @return void
	 */
	public function unban();

	/**
	 * Check if user is banned
	 *
	 * @return void
	 */
	public function isBanned();

	/**
	 * Check user throttle status.
	 *
	 * @return bool
	 * @throws \Cartalyst\Sentry\Throttling\UserBannedException
	 * @throws \Cartalyst\Sentry\Throttling\UserSuspendedException
	 */
	public function check();

	/**
	 * Saves the throttle.
	 *
	 * @return bool
	 */
	public function save();

}