Manual Reference Source Test
public class | source

FilterGroup

Mixin Extends:

FilterGroupModel, Helper

Helper class representing a filter group.

Example:

// To get a list of FilterGroups use clinical6.get
import { clinical6, FilterGroup } from 'clinical6';
clinical6.get(FilterGroup).then(c => console.log(c));

// To get a single filter_group, you can also use clinical6
clinical6.get({ id: 5, type: 'filter_groups'});

// To save or insert, you can either use the .save() capability or clinical6
myFilterGroup.save(); // insert if no id, save if id
clinical6.insert(new FilterGroup({...}));
clinical6.update(myFilterGroup);

Test:

Static Member Summary

Static Public Members
public static get

Constructor Summary

Public Constructor
public

Constructor for helper class representing a FilterGroup

Member Summary

Public Members
public get
public set
public get
public set

Method Summary

Public Methods
public

Saves a filter group (insert if id doesn't exist, update if it does)

Inherited Summary

From class FilterGroupModel
public
public
public
public

Static Public Members

public static get type: String source

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing a FilterGroup

Override:

FilterGroupModel#constructor

Params:

NameTypeAttributeDescription
json Object

json api response from server

Public Members

public get cohort: Cohort source

public set cohort: Cohort source

public get filters: Filter[] source

public set filters: Filter[] source

Public Methods

public async save(): Promise<FilterGroup> source

Saves a filter group (insert if id doesn't exist, update if it does)

Return:

Promise<FilterGroup>

Returns a promise via ajax call.

Example:

import { FilterGroup, clinical6 } from 'clinical6';

// Inserts new role (no existing id)
const filterGroup = new FilterGroup({
  "type": "filter_groups",
  "attributes": {
    "operator": "and",
    "created_at": "2018-04-19T19:16:12Z",
    "updated_at": "2018-04-19T19:16:12Z"
  },
  "relationships": {
    "cohort": {
      "data": {
        "id": "25",
        "type": "cohorts"
      }
    }
  }
});
filterGroup.save();

// Updates existing filter group (has existing id)
clinical6.get(FilterGroup).then(filterGroups => filterGroups[0].save());

Test: