src/helpers/filter/Filter.js

import { deprecate } from 'core-decorators'; // eslint-disable-line
import FilterModel from '../../models/filter/Filter';
import Helper from '../Helper';
import { aggregate } from '../../utilities/ClassUtility';
import { serviceFactory } from '../../utilities/factories/ServiceFactory';

/**
 * Helper class representing a filter.
 *
 * @extends {FilterModel}
 * @extends {Helper}
 *
 * @example
 * // To get a list of Filters use clinical6.get
 * import { clinical6, Filter } from 'clinical6';
 * clinical6.get(Filter).then(c => console.log(c));
 *
 * // To get a single filter, you can also use clinical6
 * clinical6.get({ id: 5, type: 'filters'});
 *
 * // To save or insert, you can either use the .save() capability or clinical6
 * myFilter.save(); // insert if no id, save if id
 * clinical6.insert(new Filter({...}));
 * clinical6.update(myFilter);
 */
class Filter extends aggregate(FilterModel, Helper) {
  /**
   * Constructor for helper class representing a Filter
   *
   * @param {Object} json - json api response from server
   */
  constructor(json = {}) {
    super(json);
    this.deserializeRelationshipStubs(json);
    this.syncRelationships(json);
  }

  /** @type {FitlerGroup} */
  get filterGroup() {
    return this._relationships.filter_group;
  }

  /** @type {FilterGroup} */
  set filterGroup(filterGroup) {
    /** @type {FilterGroup} */
    this._relationships.filter_group = filterGroup;
  }

  /** @type {String}  - The type */
  static get type() {
    return 'filters';
  }

  /**
   * Saves a filter (insert if id doesn't exist, update if it does)
   * @return {Promise<Filter>} - Returns a promise via ajax call.
   *
   * @example
   * import { Filter, clinical6 } from 'clinical6';
   *
   * // Inserts new role (no existing id)
   * const filter = new Filter({...});
   * filter.save();
   *
   * // Updates existing filter (has existing id)
   * clinical6.get(Filter).then(filters => filters[0].save());
   */
  async save() {
    const service = serviceFactory.get(this.type);
    return (this.id) ? service.update(this) : service.insert(this);
  }
}

export default Filter;