org.researchstack.skin.task

Class SmartSurveyTask

java.lang.Object

org.researchstack.backbone.task.Task

org.researchstack.skin.task.SmartSurveyTask

All Implemented Interfaces:

java.io.Serializable

public class SmartSurveyTask
extends org.researchstack.backbone.task.Task
implements java.io.Serializable

This Task allows creation of a special survey from json that has custom navigation logic.

Based on the user's answers to questions, they may be taken to a specific step rather than the next one in the task.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.researchstack.backbone.task.Task

org.researchstack.backbone.task.Task.InvalidTaskException, org.researchstack.backbone.task.Task.TaskProgress, org.researchstack.backbone.task.Task.ViewChangeType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	END_OF_SURVEY_MARKER

Constructor Summary

Constructors

Constructor and Description
SmartSurveyTask(android.content.Context context, TaskModel taskModel) Creates a SmartSurveyTask from a TaskModel object

Method Summary

Modifier and Type	Method and Description
org.researchstack.backbone.task.Task.TaskProgress	getProgressOfCurrentStep(org.researchstack.backbone.step.Step step, org.researchstack.backbone.result.TaskResult result)
org.researchstack.backbone.step.Step	getStepAfterStep(org.researchstack.backbone.step.Step step, org.researchstack.backbone.result.TaskResult result) Returns the next step in the task based on current answers, or null if at the end.
org.researchstack.backbone.step.Step	getStepBeforeStep(org.researchstack.backbone.step.Step step, org.researchstack.backbone.result.TaskResult result) Returns the step that should be before the current step based on current results.
org.researchstack.backbone.step.Step	getStepWithIdentifier(java.lang.String identifier)
java.lang.String	getTitleForStep(android.content.Context context, org.researchstack.backbone.step.Step step) Returns the current progress String for use in the action bar
void	validateParameters()

Methods inherited from class org.researchstack.backbone.task.Task

getIdentifier, onViewChange

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

END_OF_SURVEY_MARKER

public static final java.lang.String END_OF_SURVEY_MARKER

See Also:

Constant Field Values

Constructor Detail

SmartSurveyTask

public SmartSurveyTask(android.content.Context context,
                       TaskModel taskModel)

Creates a SmartSurveyTask from a TaskModel object

Parameters:

context - context for fetching any resources needed

taskModel - Java representation of the task json

Method Detail

getStepAfterStep

public org.researchstack.backbone.step.Step getStepAfterStep(org.researchstack.backbone.step.Step step,
                                                             org.researchstack.backbone.result.TaskResult result)

Returns the next step in the task based on current answers, or null if at the end.

This method rebuilds the order of the steps based on the current results and returns the next one.

Specified by:

getStepAfterStep in class org.researchstack.backbone.task.Task

Parameters:

step - The reference step. Pass null to specify the first step.

result - A snapshot of the current set of results.

Returns:

the Step to navigate to

getStepBeforeStep

public org.researchstack.backbone.step.Step getStepBeforeStep(org.researchstack.backbone.step.Step step,
                                                              org.researchstack.backbone.result.TaskResult result)

Returns the step that should be before the current step based on current results.

This method rebuilds the order of the remaining steps based on the current results and returns the previous one to the current step.

Specified by:

getStepBeforeStep in class org.researchstack.backbone.task.Task

Parameters:

step - The reference step. Pass null to specify the last step.

result - A snapshot of the current set of results.

Returns:

the Step to navigate to

getStepWithIdentifier

public org.researchstack.backbone.step.Step getStepWithIdentifier(java.lang.String identifier)

Specified by:

getStepWithIdentifier in class org.researchstack.backbone.task.Task

getTitleForStep

public java.lang.String getTitleForStep(android.content.Context context,
                                        org.researchstack.backbone.step.Step step)

Returns the current progress String for use in the action bar

This is updated based on the current and total in the dynamic list of steps.

Overrides:

getTitleForStep in class org.researchstack.backbone.task.Task

Parameters:

context - for fetching resources

step - the current step

Returns:

getProgressOfCurrentStep

public org.researchstack.backbone.task.Task.TaskProgress getProgressOfCurrentStep(org.researchstack.backbone.step.Step step,
                                                                                  org.researchstack.backbone.result.TaskResult result)

Specified by:

getProgressOfCurrentStep in class org.researchstack.backbone.task.Task

validateParameters

public void validateParameters()

Specified by:

validateParameters in class org.researchstack.backbone.task.Task