DHIS2 Android SDK/org.hisp.dhis.android.core.enrollment/EnrollmentObjectRepository

EnrollmentObjectRepository

class EnrollmentObjectRepository : ReadWriteWithUidDataObjectRepositoryImpl<Enrollment, EnrollmentObjectRepository>

Functions

Removes the object in scope in a synchronous way. Field DataObject.syncState is marked as State.TO_UPDATE and DeletableDataObject.deleted as true. In the next upload, it will be deleted in the server. It blocks the thread and finishes as soon as the object is deleted in the database. It throws an exception if the object doesn't exist.

blockingDeleteIfExist

open override fun blockingDeleteIfExist()

Removes the object in scope in an asynchronous way. Field DataObject.syncState is marked as State.TO_POST and DeletableDataObject.deleted as true. Unlike .blockingDelete, it doesn't throw an exception if the object doesn't exist. It blocks the thread and finishes as soon as the object is deleted in the database.

blockingExists

open override fun blockingExists(): Boolean

Returns if the object exists in a synchronous way. Important: this is a blocking method and it should not be executed in the main thread. Consider the asynchronous version .exists.

blockingGet

open override fun blockingGet(): Enrollment?

Returns the object in a synchronous way. Important: this is a blocking method and it should not be executed in the main thread. Consider the asynchronous version .get.

blockingGetWithoutChildren

open override fun blockingGetWithoutChildren(): Enrollment?

delete

open override fun delete(): Completable

Removes the object in scope in an asynchronous way. Field DataObject.syncState is marked as State.TO_UPDATE and DeletableDataObject.deleted as true. In the next upload, it will be deleted in the server. It returns a Completable that completes as soon as the object is deleted in the database. The Completable fails if the object doesn't exist.

deleteIfExist

open override fun deleteIfExist(): Completable

Removes the object in scope in a synchronous way. Field DataObject.syncState is marked as State.TO_POST and DeletableDataObject.deleted as true. Unlike .delete, it doesn't throw an exception if the object doesn't exist. It returns a Completable that completes as soon as the object is deleted in the database.

exists