org.researchstack.skin

Class DataProvider

java.lang.Object

org.researchstack.skin.DataProvider

public abstract class DataProvider
extends java.lang.Object

Class used to as a buffer between the network layer and UI layer. The implementation allows the framework to be backend-agnostic

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ERROR_CONSENT_REQUIRED
static java.lang.String	ERROR_NOT_AUTHENTICATED

Constructor Summary

Constructors

Constructor and Description
DataProvider() Default Constructor

Method Summary

Modifier and Type	Method and Description
abstract rx.Observable<DataResponse>	forgotPassword(android.content.Context context, java.lang.String email) Called during sign-in if the user has forgotten their password.
static DataProvider	getInstance() Returns the singleton instance of this class.
abstract User	getUser(android.content.Context context) Returns the user object that contains any sort of information.
abstract java.lang.String	getUserEmail(android.content.Context context) Returns the email that the user used to sign in / up
abstract java.lang.String	getUserSharingScope(android.content.Context context) Gets the current sharing scope of the user.
static void	init(DataProvider instance) Initializes the DataProvider singleton.
abstract rx.Observable<DataResponse>	initialize(android.content.Context context) Called in SplashActivity to initialize the state of the app.
abstract boolean	isConsented(android.content.Context context) Returns true if user is currently consented to the study
abstract boolean	isSignedIn(android.content.Context context) Returns true if user is currently signed in
abstract boolean	isSignedUp(android.content.Context context) Returns true if user is currently signed up
abstract org.researchstack.backbone.task.Task	loadTask(android.content.Context context, SchedulesAndTasksModel.TaskScheduleModel task) Loads a Task object, this should be used in conjunction with the ResourceManager if inflating a Task from assets folder
abstract SchedulesAndTasksModel	loadTasksAndSchedules(android.content.Context context) Loads the SchedulesAndTasksModel object, this should be used in conjunction with the ResourceManager if inflating the TaskAndSchedules object from assets folder
abstract void	processInitialTaskResult(android.content.Context context, org.researchstack.backbone.result.TaskResult taskResult) This initial task may include profile items such as height and weight that may need to be processed differently than a normal task result.
abstract rx.Observable<DataResponse>	resendEmailVerification(android.content.Context context, java.lang.String email) Called in EmailVerificationActivity to alert the backend to resend a vertification email
abstract void	saveConsent(android.content.Context context, org.researchstack.backbone.result.TaskResult consentResult) This method is responsible in saving user consent information (e.g.
abstract void	setUserSharingScope(android.content.Context context, java.lang.String scope) Sets the current sharing scope of the user.
abstract rx.Observable<DataResponse>	signIn(android.content.Context context, java.lang.String username, java.lang.String password) Called in SignUpStepLayout to sign the user in to the backend service
abstract rx.Observable<DataResponse>	signOut(android.content.Context context) Currently not used within the framework
abstract rx.Observable<DataResponse>	signUp(android.content.Context context, java.lang.String email, java.lang.String username, java.lang.String password) Called in SignUpStepLayout to sign the user up to the backend service
abstract void	uploadConsent(android.content.Context context, org.researchstack.backbone.result.TaskResult consentResult) This method is responsible in uploading the user consent information (e.g.
abstract void	uploadTaskResult(android.content.Context context, org.researchstack.backbone.result.TaskResult taskResult) Method used to upload a TaskResult to the backend
abstract rx.Observable<DataResponse>	withdrawConsent(android.content.Context context, java.lang.String reason) Called in SettingsFragment to alert the backend that the user wants to withdraw from the study

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_NOT_AUTHENTICATED

public static final java.lang.String ERROR_NOT_AUTHENTICATED

See Also:

Constant Field Values

ERROR_CONSENT_REQUIRED

public static final java.lang.String ERROR_CONSENT_REQUIRED

See Also:

Constant Field Values

Constructor Detail

DataProvider

public DataProvider()

Default Constructor

Method Detail

getInstance

public static DataProvider getInstance()

Returns the singleton instance of this class.

Returns:

the singleton instance of this class

init

public static void init(DataProvider instance)

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

Parameters:

instance - an implementation of DataProvider

initialize

public abstract rx.Observable<DataResponse> initialize(android.content.Context context)

Called in SplashActivity to initialize the state of the app. The state includes if the user is not signed in/up, not consented, etc..

Parameters:

context - android context

Returns:

Observable of the result of the method, with DataResponse.isSuccess() returning true if signUp was successful

signUp

public abstract rx.Observable<DataResponse> signUp(android.content.Context context,
                                                   java.lang.String email,
                                                   java.lang.String username,
                                                   java.lang.String password)

Called in SignUpStepLayout to sign the user up to the backend service

Parameters:

context - android context

Returns:

Observable of the result of the method, with DataResponse.isSuccess() returning true if signUp was successful

signIn

public abstract rx.Observable<DataResponse> signIn(android.content.Context context,
                                                   java.lang.String username,
                                                   java.lang.String password)

Called in SignUpStepLayout to sign the user in to the backend service

Parameters:

context - android context

Returns:

Observable of the result of the method, with DataResponse.isSuccess() returning true if signIn was successful

signOut

public abstract rx.Observable<DataResponse> signOut(android.content.Context context)

Currently not used within the framework

Parameters:

context - android context

Returns:

Observable of the result of the method, with DataResponse.isSuccess() returning true if signOut was successful

resendEmailVerification

public abstract rx.Observable<DataResponse> resendEmailVerification(android.content.Context context,
                                                                    java.lang.String email)

Called in EmailVerificationActivity to alert the backend to resend a vertification email

Parameters:

context - android context

Returns:

Observable of the result of the method, with DataResponse.isSuccess() returning true if signIn was successful

isSignedUp

public abstract boolean isSignedUp(android.content.Context context)

Returns true if user is currently signed up

Parameters:

context - android context

Returns:

true if user is signed up

isSignedIn

public abstract boolean isSignedIn(android.content.Context context)

Returns true if user is currently signed in

Parameters:

context - android context

Returns:

true if user is signed in

isConsented

public abstract boolean isConsented(android.content.Context context)

Returns true if user is currently consented to the study

Parameters:

context - android context

Returns:

true if user is currently consented

withdrawConsent

public abstract rx.Observable<DataResponse> withdrawConsent(android.content.Context context,
                                                            java.lang.String reason)

Called in SettingsFragment to alert the backend that the user wants to withdraw from the study

Parameters:

context - android context

Returns:

Observable of the result of the method, with DataResponse.isSuccess() returning true if withdrawl was successful

uploadConsent

public abstract void uploadConsent(android.content.Context context,
                                   org.researchstack.backbone.result.TaskResult consentResult)

This method is responsible in uploading the user consent information (e.g. Name, Birthdate, Signature) to the backend

Parameters:

context - android context

saveConsent

public abstract void saveConsent(android.content.Context context,
                                 org.researchstack.backbone.result.TaskResult consentResult)

This method is responsible in saving user consent information (e.g. Name, Birthdate, Signature) locally.

Please use FileAccess class to encrypt user information when saving.

Parameters:

context - android context

getUser

public abstract User getUser(android.content.Context context)

Returns the user object that contains any sort of information. This information can be collected in the inital survey and sorted using this object

Parameters:

context - android context

Returns:

User object

getUserSharingScope

public abstract java.lang.String getUserSharingScope(android.content.Context context)

Gets the current sharing scope of the user.

This scope can be:

sponsors_and_partners all_quali5dfied_researchers

Parameters:

context - android context

Returns:

the sharing scope of the user

setUserSharingScope

public abstract void setUserSharingScope(android.content.Context context,
                                         java.lang.String scope)

Sets the current sharing scope of the user. This method should tell the backend that the sharing scope has changed.

Parameters:

context - android context

scope - the new sharing scope of the user

getUserEmail

public abstract java.lang.String getUserEmail(android.content.Context context)

Returns the email that the user used to sign in / up

Parameters:

context - android context

Returns:

return the email that the user used to sign in/up

uploadTaskResult

public abstract void uploadTaskResult(android.content.Context context,
                                      org.researchstack.backbone.result.TaskResult taskResult)

Method used to upload a TaskResult to the backend

Parameters:

context - android context

taskResult - TaskResult object to upload

loadTasksAndSchedules

public abstract SchedulesAndTasksModel loadTasksAndSchedules(android.content.Context context)

Loads the SchedulesAndTasksModel object, this should be used in conjunction with the ResourceManager if inflating the TaskAndSchedules object from assets folder

Parameters:

context - android context

Returns:

a SchedulesAndTasksModel object

loadTask

public abstract org.researchstack.backbone.task.Task loadTask(android.content.Context context,
                                                              SchedulesAndTasksModel.TaskScheduleModel task)

Loads a Task object, this should be used in conjunction with the ResourceManager if inflating a Task from assets folder

Parameters:

context - android context

task - the TaskScheduleModel model

Returns:

a Task object with defined sub-steps

processInitialTaskResult

public abstract void processInitialTaskResult(android.content.Context context,
                                              org.researchstack.backbone.result.TaskResult taskResult)

This initial task may include profile items such as height and weight that may need to be processed differently than a normal task result. This task is presented to the user when initially entering the MainActivity

Parameters:

context - android context

taskResult - initial TaskResult object to process

forgotPassword

public abstract rx.Observable<DataResponse> forgotPassword(android.content.Context context,
                                                           java.lang.String email)

Called during sign-in if the user has forgotten their password. This should make a network call to notify the backend.

Parameters:

context - android context

email - email of the user

Returns:

Observable of the result of the method, with DataResponse.isSuccess() returning true if forgitpassword request was successful