<?php
/**
 * Type to hold the parsed skiptoken value. The IDSQP implementor 
 * can use these details if they want to do custom paging.
 * 
 * PHP version 5.3
 * 
 * @category  ODataPHPProd
 * @package   ODataProducer_UriProcessor_QueryProcessor_SkipTokenParser
 * @author    Microsoft Open Technologies, Inc. <msopentech@microsoft.com>
 * @copyright Microsoft Open Technologies, Inc.
 * @license   New BSD license, (http://www.opensource.org/licenses/bsd-license.php)
 * @version   GIT: 1.2
 * @link      https://github.com/MSOpenTech/odataphpprod
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *  Redistributions of source code must retain the above copyright notice, this list
 *  of conditions and the following disclaimer.
 *  Redistributions in binary form must reproduce the above copyright notice, this
 *  list of conditions  and the following disclaimer in the documentation and/or
 *  other materials provided with the distribution.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A  PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)  HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
namespace ODataProducer\UriProcessor\QueryProcessor\SkipTokenParser;
use ODataProducer\Common\Messages;
use ODataProducer\Providers\Metadata\ResourceType;
use ODataProducer\UriProcessor\QueryProcessor\OrderByParser\OrderByInfo;
/**
 * Type to hold the parsed skiptoken value
 *
 * @category  ODataPHPProd
 * @package   ODataProducer_UriProcessor_QueryProcessor_SkipTokenParser
 * @author    Microsoft Open Technologies, Inc. <msopentech@microsoft.com>
 * @copyright Microsoft Open Technologies, Inc.
 * @license   New BSD license, (http://www.opensource.org/licenses/bsd-license.php)
 * @version   GIT: 1.2
 * @link      https://github.com/MSOpenTech/odataphpprod
 */
class SkipTokenInfo
{
    /**
     * Type to hold information about the navigation properties used in the 
     * orderby clause (if any) and orderby path.
     * 
     * @var OrderByInfo
     */
    private $_orderByInfo;

    /**
     * Holds collection of values in the skiptoken corrosponds to the orderby
     * path segments.
     * 
     * @var array(int (array(string, IType)
     */
    private $_orderByValuesInSkipToken;

    /**
     * Constructs a new instance of SkipTokenInfo.
     * 
     * @param OrderByInfo                      &$orderByInfo             Type holding information about the navigation properties 
     *                                                                   used in the orderby clause (if any) and orderby path.
     * @param array(int,(array(string,IType))) $orderByValuesInSkipToken Collection of values in the skiptoken corrosponds
     *                                                                   to the orderby path segments.
     */
    public function __construct(OrderByInfo &$orderByInfo, $orderByValuesInSkipToken)
    {
        $this->_orderByInfo = $orderByInfo;
        $this->_orderByValuesInSkipToken = $orderByValuesInSkipToken;
    }

    /**
     * Get reference to the OrderByInfo instance holdint information about the 
     * navigation properties used in the rderby clause (if any) and orderby path.
     * 
     * @return OrderByInfo
     */
    public function getOrderByInfo()
    {
        return $this->_orderByInfo;
    }

    /**
     * Gets collection of values in the skiptoken corrosponds to the orderby 
     * path segments.
     * 
     * @return array(int,(array(string,IType)))
     */
    public function getOrderByKeysInToken()
    {
        return $this->_orderByValuesInSkipToken;
    }
}
?>