org.researchstack.backbone.storage.database

Interface AppDatabase

All Known Implementing Classes:

DatabaseHelper, SqlCipherDatabaseHelper

public interface AppDatabase

Whatever database implementation you use should implement these methods for basic saving of TaskResult and StepResult. It also provides a method for setting the encryption key of the database, for encrypted databases (do nothing if your database is not encrypted).

Method Summary

Modifier and Type	Method and Description
TaskResult	loadLatestTaskResult(java.lang.String taskIdentifier) Loads the latest task result for the given task identifier.
java.util.List<StepResult>	loadStepResults(java.lang.String stepIdentifier) Returns a list of all StepResults for the given step identifier.
java.util.List<TaskResult>	loadTaskResults(java.lang.String taskIdentifier) Returns a list of all TaskResults for the given task identifier.
void	saveTaskResult(TaskResult result) Saves the TaskResult to the database, along with its child StepResults
void	setEncryptionKey(java.lang.String key) Sets the encryption key on the database.

Method Detail

saveTaskResult

void saveTaskResult(TaskResult result)

Saves the TaskResult to the database, along with its child StepResults

Parameters:

result - the task result to save

loadLatestTaskResult

TaskResult loadLatestTaskResult(java.lang.String taskIdentifier)

Loads the latest task result for the given task identifier.

This can be used to see when the user last answered the survey, or to get their most recent answer to a survey question.

Parameters:

taskIdentifier - the task identifier

Returns:

the latest TaskResult for the given identifier, or none

loadTaskResults

java.util.List<TaskResult> loadTaskResults(java.lang.String taskIdentifier)

Returns a list of all TaskResults for the given task identifier.

Parameters:

taskIdentifier - the task identifier

Returns:

a list of all TaskResults for the given identifier

loadStepResults

java.util.List<StepResult> loadStepResults(java.lang.String stepIdentifier)

Returns a list of all StepResults for the given step identifier.

Parameters:

stepIdentifier - the step identifier

Returns:

a list of all StepResults for the given identifier

setEncryptionKey

void setEncryptionKey(java.lang.String key)

Sets the encryption key on the database. If your database doesn't support encryption, make this a no-op.

Parameters:

key - a string key to be used to encrypt the database