grade/amd/src/grades/grader/gradingpanel/normalise.js

  1. // This file is part of Moodle - http://moodle.org/
  2. //
  3. // Moodle is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU General Public License as published by
  5. // the Free Software Foundation, either version 3 of the License, or
  6. // (at your option) any later version.
  7. //
  8. // Moodle is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16. /**
  17.  * Error handling and normalisation of provided data.
  18.  *
  19.  * @module     core_grades/grades/grader/gradingpanel/normalise
  20.  * @copyright  2019 Andrew Nicols <andrew@nicols.co.uk>
  21.  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22.  */
  24. /**
  25.  * Normalise a resultset for consumption by the grader.
  26.  *
  27.  * @param {Object} result The result returned from a grading web service
  28.  * @return {Object}
  29.  */
  30. export const normaliseResult = result => {
  31.     return {
  32.         result,
  33.         failed: !!result.warnings.length,
  34.         success: !result.warnings.length,
  35.         error: null,
  36.     };
  37. };
  39. /**
  40.  * Return the resultset used to describe an invalid result.
  41.  *
  42.  * @return {Object}
  43.  */
  44. export const invalidResult = () => {
  45.     return {
  46.         success: false,
  47.         failed: false,
  48.         result: {},
  49.         error: null,
  50.     };
  51. };
  53. /**
  54.  * Return the resultset used to describe a failed update.
  55.  *
  56.  * @param {Object} error
  57.  * @return {Object}
  58.  */
  59. export const failedUpdate = error => {
  60.     return {
  61.         success: false,
  62.         failed: true,
  63.         result: {},
  64.         error,
  65.     };
  66. };