<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_OAuth
 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */

/**
 * @namespace
 */
namespace Zend\OAuth;

use Zend\Http\Response as HTTPResponse,
    Zend\OAuth\Http\Utility as HTTPUtility;


interface Token
{

    /**
     * Retrieve an arbitrary named parameter from the token
     * 
     * @param  string $name 
     * @return mixed
     */
    public function getParam($name);

    /**
     * Retrieve the response object this token is operating on
     * 
     * @return Zend\Http\Response
     */
    public function getResponse();

    /**
     * Retrieve the token value
     * 
     * @return string
     */
    public function getToken();

    /**
     * Retrieve the Token's secret, for use with signing requests
     * 
     * @return string
     */
    public function getTokenSecret();

    /**
     * Set the Token's signing secret.
     * 
     * @param  string $secret 
     * @return Zend\OAuth\Token
     */
    public function setTokenSecret($secret);

    /**
     * Validate the Token against the HTTP Response
     * 
     * @return boolean
     */
    public function isValid();

    /**
     * Convert token to a raw-encoded query string
     * 
     * @return string
     */
    public function toString();

    /**
     * Cast Token to string representation; should proxy to toString()
     * 
     * @return string
     */
    public function __toString();
}
