app/com.example.examer.data.remote/RemoteDatabase

RemoteDatabase

An interface that contains the requisite methods for a remote database.

Functions

abstract suspend fun fetchActiveTestListForUser(user: ExamerUser): List<TestDetails>

Used to fetch a list of active tests for the specified user. An active test is any instance of TestDetails with TestDetails.testStatus set to Status.OPEN or Status.SCHEDULED. The returned list will contain both, tests which are open and tests which are scheduled.

fetchPreviousTestListForUser

abstract suspend fun fetchPreviousTestListForUser(user: ExamerUser): List<TestDetails>

Used to fetch a list of previous tests for the specified user.

fetchResultsForTest

abstract suspend fun fetchResultsForTest(user: ExamerUser, testDetailsId: String): TestResult

Used to fetch the TestResult of a single test with the specified testDetailsId for a specific user.

fetchWorkBookList

abstract suspend fun fetchWorkBookList(user: ExamerUser, testDetails: TestDetails): Result<List<WorkBookDTO>>

Used to fetch a list of WorkBooks associated with a specific TestDetails object, for the specified user. An instance of Result containing the list is returned.

markTestAsCompleted

abstract suspend fun markTestAsCompleted(user: ExamerUser, testDetailsId: String)

Used to mark a test with the associated testDetailsId as complete.

markTestAsMissed

abstract suspend fun markTestAsMissed(user: ExamerUser, testDetailsId: String)

Used to mark a test with the associated testDetailsId as missed.

saveBitmap

abstract suspend fun saveBitmap(bitmap: Bitmap, fileName: String): Result<Uri>

Used to save an instance of bitmap with the specified fileName. It returns an instance of Result containing the associated Uri.

saveUserAnswers

abstract suspend fun saveUserAnswers( user: ExamerUser, userAnswers: UserAnswers, testDetailsId: String)

Used to save the userAnswers associated with a particular test, with the specified testDetailsId, for the specified user.

Inheritors

FirebaseRemoteDatabase