org.researchstack.backbone.task

Class OrderedTask

java.lang.Object

org.researchstack.backbone.task.Task

org.researchstack.backbone.task.OrderedTask

All Implemented Interfaces:

java.io.Serializable

public class OrderedTask
extends Task
implements java.io.Serializable

The OrderedTask class implements all the methods in the Task protocol and represents a task that assumes a fixed order for its steps.

In the ResearchStack framework, any simple sequential task, such as a survey or an active task, can be represented as an ordered task.

If you want further custom conditional behaviors in a task, it can be easier to subclass OrderedTask or NavigableOrderedTask and override particular Task methods than it is to implement a new Task subclass directly. Override the methods getStepAfterStep(org.researchstack.backbone.step.Step, org.researchstack.backbone.result.TaskResult) and getStepBeforeStep(org.researchstack.backbone.step.Step, org.researchstack.backbone.result.TaskResult), and call super for all other methods.

See Also:

Serialized Form

Nested Class Summary

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

Task.InvalidTaskException, Task.TaskProgress, Task.ViewChangeType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Step>	steps

Constructor Summary

Constructors

Constructor and Description
OrderedTask(java.lang.String identifier, java.util.List<Step> steps) Returns an initialized ordered task using the specified identifier and array of steps.
OrderedTask(java.lang.String identifier, Step... steps) Returns an initialized ordered task using the specified identifier and array of steps.

Method Summary

Modifier and Type	Method and Description
Task.TaskProgress	getProgressOfCurrentStep(Step step, TaskResult result) Returns the progress of the current step.
Step	getStepAfterStep(Step step, TaskResult result) Returns the next step immediately after the passed in step in the list of steps, or null
Step	getStepBeforeStep(Step step, TaskResult result) Returns the next step immediately before the passed in step in the list of steps, or null
java.util.List<Step>	getSteps() Returns a copy of the list of steps.
Step	getStepWithIdentifier(java.lang.String identifier) Returns the step that matches the specified identifier, if there is one.
java.lang.String	getTitleForStep(android.content.Context context, Step step) Returns Step.getStepTitle() if it exists, otherwise returns string showing progress.
void	validateParameters() Validates that there are no duplicate identifiers in the list of steps

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

steps

protected java.util.List<Step> steps

Constructor Detail

OrderedTask

public OrderedTask(java.lang.String identifier,
                   java.util.List<Step> steps)

Returns an initialized ordered task using the specified identifier and array of steps.

Parameters:

identifier - The unique identifier for the task.

steps - An array of Step objects in the order in which they should be presented.

OrderedTask

public OrderedTask(java.lang.String identifier,
                   Step... steps)

Returns an initialized ordered task using the specified identifier and array of steps.

Parameters:

identifier - The unique identifier for the task

steps - The Step objects in the order in which they should be presented.

Method Detail

getStepAfterStep

public Step getStepAfterStep(Step step,
                             TaskResult result)

Returns the next step immediately after the passed in step in the list of steps, or null

Specified by:

getStepAfterStep in class Task

Parameters:

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

result - A snapshot of the current set of results.

Returns:

the next step in steps after the passed in step, or null if at the end

getStepBeforeStep

public Step getStepBeforeStep(Step step,
                              TaskResult result)

Returns the next step immediately before the passed in step in the list of steps, or null

Specified by:

getStepBeforeStep in class Task

Parameters:

step - The reference step.

result - A snapshot of the current set of results.

Returns:

the next step in steps before the passed in step, or null if at the start

getStepWithIdentifier

public Step getStepWithIdentifier(java.lang.String identifier)

Description copied from class: Task

Returns the step that matches the specified identifier, if there is one.

Specified by:

getStepWithIdentifier in class Task

Parameters:

identifier - The identifier of the step to retrieve.

Returns:

The step that matches the specified identifier.

getProgressOfCurrentStep

public Task.TaskProgress getProgressOfCurrentStep(Step step,
                                                  TaskResult result)

Description copied from class: Task

Returns the progress of the current step.

During a task, the ViewTaskActivity can display the progress (that is, the current step number out of the total number of steps) in the navigation bar. Implement this method to control what is displayed; if you don't implement this method, the progress label does not appear.

If the returned Task.TaskProgress object has a count of 0, the progress is not displayed.

Specified by:

getProgressOfCurrentStep in class Task

Parameters:

step - The current step.

result - A snapshot of the current set of results.

Returns:

The current step's index and the total number of steps in the task, as an TaskProgress object.

getTitleForStep

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

Returns Step.getStepTitle() if it exists, otherwise returns string showing progress.

Overrides:

getTitleForStep in class Task

Parameters:

context - for fetching resources

step - the current step

Returns:

the step title, or a progress string if it doesn't have one

validateParameters

public void validateParameters()

Validates that there are no duplicate identifiers in the list of steps

Specified by:

validateParameters in class Task

Throws:

Task.InvalidTaskException

getSteps

public java.util.List<Step> getSteps()

Returns a copy of the list of steps.

Returns:

a copy of the ordered list of steps in the task