import FlowStep from 'clinical6/src/helpers/flow/FlowStep.js'

public class | source

FlowStep

Expression Extends:

class FlowStep extends aggregate(FlowStepModel, Helper, Commentable)

Helper class representing a flow step object. Required values include:

id
title
description
content_type
image
inputs
paths

Constructor Summary

Public Constructor
public	constructor(response: Object, flow: Flow) Constructor for FlowStep

Member Summary

Public Members
public get	existingId: Number Gets the existing id for this FlowStep (in _options)
public set	existingId: Number Set the existing id for this FlowStep (id)
public get	fields: Object Get Fields used only for this step
public	flow: Flow
public	inputs: FlowInput[]
public get	type: String

Private Members
private	_options: Object

Method Summary

Public Methods
public	addFieldsToSave() Save fields for later
public	get(key: String): Any Get value from key
public	getNextStep(steps: Array<any>): * Get Next Step based on an array of steps and the conditions belonging to it
public	getPath(name: String): Object Get Path given the name of the path
public	go(name: String): Promise<FlowStep> Go to a node given the path name
public	hasFields(): Boolean Has Fields
public	hasSteps(path: Object): Boolean Has Steps
public	initFields() Initializes the fields for insertion
public	isAutoSave(path: Object): Boolean Is AutoSave will return whether or not the path has capture on or off
public	isFieldRequired(id: String): Boolean Indicates whether a field is required based on the flowstep.input array
public	onSave(results: Object): Object Is run after a successful save (FlowStep Scope).
public	postInsights(action: String): Promise<any> Post Insight on this flow step
public	save(): Promise Save makes a server call to update/insert the current fields.
public	set(key: String, value: Any, existingId: Number) Set value to main key
public	validateRequiredFields(path: any) Validate Required Fields for a path.

Public Constructors

public constructor(response: Object, flow: Flow) source

Constructor for FlowStep

Params:

Name	Type	Attribute	Description
response	Object	nullable: false	Expects all required fields needed for FlowStepModel
response.id	Number		The id of the step
response.title	Object		The title of the step
response.description	Object		Description, if any, that explain how to answer the step
response.content_type	String		The format of the step (e.g. single choice, multiple choice)
response.choices	Array		An array of inputs available to the user
response.paths	Array		An array of next steps available to the user
response.send_on_capture	Boolean		Save now or later
flow	Flow	nullable: true	Required to link up fields to the flow.

Public Members

public get existingId: Number source

Gets the existing id for this FlowStep (in _options)

public set existingId: Number source

Set the existing id for this FlowStep (id)

public get fields: Object source

Get Fields used only for this step

public flow: Flow source

public inputs: FlowInput[] source

public get type: String source

Private Members

private _options: Object source

Public Methods

public addFieldsToSave() source

Save fields for later

public get(key: String): Any source

Get value from key

Params:

Name	Type	Attribute	Description
key	String		Key must be 'input_id'

Return:

Any	value This is the user response given the key

public getNextStep(steps: Array<any>): * source

Get Next Step based on an array of steps and the conditions belonging to it

Params:

Name	Type	Attribute	Description
steps	Array<any>

Return:

*	null or a FlowStep

public getPath(name: String): Object source

Get Path given the name of the path

Params:

Name	Type	Attribute	Description
name	String		The name of the path

Return:

Object

The path object with conditions, steps, and capture

Test:

[unit] FlowStep.getPath should exist

public go(name: String): Promise<FlowStep> source

Go to a node given the path name

Params:

Name	Type	Attribute	Description
name	String		Name of the button

Return:

Promise<FlowStep>

The next step or null.

Test:

public hasFields(): Boolean source

Has Fields

Return:

Boolean

True if the step has fields, otherwise false

Test:

[unit] FlowStep.hasFields should exist

public hasSteps(path: Object): Boolean source

Has Steps

Params:

Name	Type	Attribute	Description
path	Object		Path object

Return:

Boolean

True if the path has steps

Test:

[unit] FlowStep.hasSteps should exist

public initFields() source

Initializes the fields for insertion

Test:

[unit] FlowStep.initFields should exist

public isAutoSave(path: Object): Boolean source

Is AutoSave will return whether or not the path has capture on or off

Params:

Name	Type	Attribute	Description
path	Object		Path object

Return:

Boolean

True if autosave / capture is on for the path

Test:

[unit] FlowStep.isAutoSave should exist

public isFieldRequired(id: String): Boolean source

Indicates whether a field is required based on the flowstep.input array

Params:

Name	Type	Attribute	Description
id	String		The input id

Return:

Boolean

Returns true if the input is required else false

public onSave(results: Object): Object source

Is run after a successful save (FlowStep Scope).

Params:

Name	Type	Attribute	Description
results	Object		results of the save event

Return:

Object

returns the results

public postInsights(action: String): Promise<any> source

Post Insight on this flow step

Params:

Name	Type	Attribute	Description
action	String		The action that is being tracked

Return:

Promise<any>

returns the results

Example:

flowstep.postInsights('collect') = (response) => {
  // do something with the save response
  return response;
}

public save(): Promise source

Save makes a server call to update/insert the current fields. This requires that the array is [{input_id: <input_id>, value: <value>},...]

Return:

Promise

A Promise returning success or failure from FlowService

Test:

public set(key: String, value: Any, existingId: Number) source

Set value to main key

Params:

Name	Type	Attribute	Description
key	String		Key must be 'input_id'
value	Any		This must be the expected value for this question type.
existingId	Number	nullable: true	The existing id to update an object to

Test:

[unit] FlowStep.set should exist

public validateRequiredFields(path: any) source

Validate Required Fields for a path. If the path has fields to be captured and are empty, throw an error indicating which path and what fields.

Params:

Name	Type	Attribute	Description
path	any		The Path the flow step has taken to see if related inputs are required.