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


/**
 * Missing Parameter are thrown for missing parameters that are not strongly passed (sub protocols)
 *
 * @access public
 * @author Patrick Plichart
 * @package generis
 */
class common_exception_MissingParameter extends common_exception_BadRequest
{
    public function __construct($parameterName = '', $service = '')
    {
        $message = sprintf(
            'Expected parameter%s%s is missing',
            $parameterName ? ' ' . $parameterName : '',
            $service ? ' passed to ' . $service : ''
        );
        parent::__construct($message);
    }

    public function getUserMessage()
    {
        return __("At least one mandatory parameter was required but found missing in your request");
    }
}