All files / ima/controller AbstractController.js

66.67% Statements 14/21
50% Branches 3/6
31.25% Functions 5/16
66.67% Lines 14/21
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165        1x                         4x               4x             4x             4x                 4x                                                       1x                                 1x 1x               2x 1x   1x                                                                                             5x                     1x  
import ns from '../namespace';
import GenericError from '../error/GenericError';
import Controller from './Controller';
 
ns.namespace('ima.controller');
 
/**
 * Basic implementation of the {@codelink Controller} interface, providing the
 * default implementation of the most of the API.
 *
 * @abstract
 */
export default class AbstractController extends Controller {
  /**
	 * Initializes the controller.
	 */
  constructor() {
    super();
 
    /**
		 * State manager.
		 *
		 * @protected
		 * @type {PageStateManager}
		 */
    this._pageStateManager = null;
 
    /**
		 * The controller's extensions.
		 *
		 * @type {Extension[]}
		 */
    this._extensions = [];
 
    /**
		 * The HTTP response code to send to the client.
		 *
		 * @type {number}
		 */
    this.status = 200;
 
    /**
		 * The route parameters extracted from the current route. This field is
		 * set externally by IMA right before the {@linkcode init()} or the
		 * {@linkcode update()} method is called.
		 *
		 * @type {Object<string, string>}
		 */
    this.params = {};
  }
 
  /**
	 * @inheritdoc
	 */
  init() {}
 
  /**
	 * @inheritdoc
	 */
  destroy() {}
 
  /**
	 * @inheritdoc
	 */
  activate() {}
 
  /**
	 * @inheritdoc
	 */
  deactivate() {}
 
  /**
	 * @inheritdoc
	 * @abstract
	 */
  load() {
    throw new GenericError(
      'The ima.controller.AbstractController.load method is abstract ' +
        'and must be overridden'
    );
  }
 
  /**
	 * @inheritdoc
	 */
  update(params = {}) {
    return {};
  }
 
  /**
	 * @inheritdoc
	 */
  setState(statePatch) {
    Eif (this._pageStateManager) {
      this._pageStateManager.setState(statePatch);
    }
  }
 
  /**
	 * @inheritdoc
	 */
  getState() {
    if (this._pageStateManager) {
      return this._pageStateManager.getState();
    } else {
      return {};
    }
  }
 
  /**
	 * @inheritdoc
	 */
  addExtension(extension) {
    this._extensions.push(extension);
  }
 
  /**
	 * @inheritdoc
	 */
  getExtensions() {
    return this._extensions;
  }
 
  /**
	 * @inheritdoc
	 * @abstract
	 */
  setMetaParams(loadedResources, metaManager, router, dictionary, settings) {
    throw new GenericError(
      'The ima.controller.AbstractController.setMetaParams method is ' +
        'abstract and must be overridden'
    );
  }
 
  /**
	 * @inheritdoc
	 */
  setRouteParams(params = {}) {
    this.params = params;
  }
 
  /**
	 * @inheritdoc
	 */
  getRouteParams() {
    return this.params;
  }
 
  /**
	 * @inheritdoc
	 */
  setPageStateManager(pageStateManager) {
    this._pageStateManager = pageStateManager;
  }
 
  /**
	 * @inheritdoc
	 */
  getHttpStatus() {
    return this.status;
  }
}
 
ns.ima.controller.AbstractController = AbstractController;