org.researchstack.skin

Class TaskProvider

java.lang.Object

org.researchstack.skin.TaskProvider

public abstract class TaskProvider
extends java.lang.Object

TaskProvider is used as a way for the Framework to get Tasks needed throughout the onboarding process. This allows you to implement your own Tasks if needed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TASK_ID_CONSENT Task ID used by the framework for looking up the consent task
static java.lang.String	TASK_ID_INITIAL Task ID used by the framework for looking up the "initial" task
static java.lang.String	TASK_ID_SIGN_IN Task ID used by the framework for looking up the sign-in task
static java.lang.String	TASK_ID_SIGN_UP Task ID used by the framework for looking up the sign-up task

Constructor Summary

Constructors

Constructor and Description
TaskProvider()

Method Summary

Modifier and Type	Method and Description
abstract org.researchstack.backbone.task.Task	get(java.lang.String taskId) Used, in combination of put(String, Task), for task lookup and resuse
static TaskProvider	getInstance() Returns a singleton static instance of the this class
static void	init(TaskProvider manager) Initializes the TaskProvider singleton.
abstract void	put(java.lang.String id, org.researchstack.backbone.task.Task task) Used to store a task object for reuse

Methods inherited from class java.lang.Object

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

Field Detail

TASK_ID_INITIAL

public static final java.lang.String TASK_ID_INITIAL

Task ID used by the framework for looking up the "initial" task

See Also:

Constant Field Values

TASK_ID_CONSENT

public static final java.lang.String TASK_ID_CONSENT

Task ID used by the framework for looking up the consent task

See Also:

Constant Field Values

TASK_ID_SIGN_IN

public static final java.lang.String TASK_ID_SIGN_IN

Task ID used by the framework for looking up the sign-in task

See Also:

Constant Field Values

TASK_ID_SIGN_UP

public static final java.lang.String TASK_ID_SIGN_UP

Task ID used by the framework for looking up the sign-up task

See Also:

Constant Field Values

Constructor Detail

TaskProvider

public TaskProvider()

Method Detail

init

public static void init(TaskProvider manager)

Initializes the TaskProvider singleton. It is best to call this method inside your Application.onCreate() method.

Parameters:

manager - an implementation of ResourcePathManager

getInstance

public static TaskProvider getInstance()

Returns a singleton static instance of the this class

Returns:

A singleton static instance of the this class

get

public abstract org.researchstack.backbone.task.Task get(java.lang.String taskId)

Used, in combination of put(String, Task), for task lookup and resuse

Parameters:

taskId - the task id

Returns:

a task object with an id of

put

public abstract void put(java.lang.String id,
                         org.researchstack.backbone.task.Task task)

Used to store a task object for reuse

Parameters:

id - the task id

task - the task object