<?php

/**
 * 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; under version 2
 * of the License (non-upgradable).
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2017 (original work) Open Assessment Technologies SA ;
 *
 */

namespace oat\taoQtiTest\models\runner\time;

/**
 * Interface QtiTimeStorageFormat.
 *
 * Defines a filter that encode/decode a dataset with a particular format.
 *
 * @package oat\taoQtiTest\models\runner\time
 * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
 */
interface QtiTimeStorageFormat
{
    public const STORAGE_KEY_TIME_LINE = 'timeLine';
    public const STORAGE_KEY_EXTRA_TIME = 'extraTime';
    public const STORAGE_KEY_EXTENDED_TIME = 'extendedTime';
    public const STORAGE_KEY_CONSUMED_EXTRA_TIME = 'consumedExtraTime';
    public const STORAGE_KEY_TIMER_ADJUSTMENT_MAP = 'timerAdjustmentMap';

    /**
     * Encode a dataset with the managed format.
     * @param mixed $data
     * @return string
     */
    public function encode($data);

    /**
     * Decode a string encoded with the managed format.
     * @param string $data
     * @return mixed
     */
    public function decode($data);
}