<?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) 2015 (original work) Open Assessment Technologies SA;
 *
 *
 */

namespace oat\taoProctoring\model\monitorCache;

use oat\taoDelivery\model\execution\DeliveryExecutionContextInterface;
use oat\taoDelivery\model\execution\DeliveryExecutionInterface;
use qtism\runtime\tests\AssessmentTestSession;
use oat\taoDelivery\model\execution\DeliveryExecution;

/**
 * Interface DeliveryMonitoringData
 *
 * Represents data model of delivery execution.
 *
 * @package oat\taoProctoring\model
 * @author Aleh Hutnikau <hutnikau@1pt.com>
 */
interface DeliveryMonitoringData
{
    const PARAM_EXECUTION_CONTEXT = 'execution_context';

    /**
     * Set delivery execution
     * @param DeliveryExecution $deliveryExecution
     */
    public function setDeliveryExecution(DeliveryExecution $deliveryExecution);

    /**
     * @return DeliveryExecutionInterface
     */
    public function getDeliveryExecution();

    /**
     * @param DeliveryExecutionContextInterface $context
     */
    public function setDeliveryExecutionContext(DeliveryExecutionContextInterface $context);

    /**
     * @return DeliveryExecutionContextInterface|null
     */
    public function getDeliveryExecutionContext();

    /**
     * Set test session
     * @param AssessmentTestSession $testSession
     */
    public function setTestSession(AssessmentTestSession $testSession);

    /**
     * Get delivery execution data
     * @return array
     */
    public function get();

    /**
     * Updates a single cashed variable
     *
     * @param string $key
     * @param string $value
     */
    public function update($key, $value);

    /**
     * Validate data
     * @return boolean
     */
    public function validate();

    /**
     * Refresh all the delivery information
     * @param array|null $keys list of fields to update
     */
    public function updateData(array $keys = null);

}