DHIS2 Android SDK/org.hisp.dhis.android.core.arch.repositories.collection/ReadWriteWithUidCollectionRepository

ReadWriteWithUidCollectionRepository

interface ReadWriteWithUidCollectionRepository<M : CoreObject, ObjectWithUidInterface, O> : ReadOnlyWithUidCollectionRepository<M>

Inheritors

RelationshipCollectionRepository

FileResourceCollectionRepository

ReadWriteWithUploadWithUidCollectionRepository

Functions

add

abstract fun add(o: O): Single<String>

Adds a new object to the given collection in an asynchronous way based on the provided CreateProjection. It returns a Single<String> with the generated UID, which is completed when the object is added to the database. It adds an object with a State.TO_POST, which will be uploaded to the server in the next upload.

blockingAdd

abstract fun blockingAdd(o: O): String

Adds a new object to the given collection in a synchronous way based on the provided CreateProjection. It blocks the current thread and returns the generated UID. It adds an object with a State.TO_POST, which will be uploaded to the server in the next upload. Important: this is a blocking method and it should not be executed in the main thread. Consider the asynchronous version .add.

blockingCount

abstract fun blockingCount(): Int

Get the count of elements. Important: this is a blocking method and it should not be executed in the main thread. Consider the asynchronous version .count.

blockingGet

abstract fun blockingGet(): List<M>

Get the list of objects 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.

blockingGetUids

abstract fun blockingGetUids(): List<String>

Get the list of uids of objects in scope in a synchronous way. Important: this is a blocking method and it should not be executed in the main thread. Consider the asynchronous version .getUids.

blockingIsEmpty

abstract fun blockingIsEmpty(): Boolean

Check if selection of objects with applied filters is empty in a synchronous way. Important: this is a blocking method and it should not be executed in the main thread. Consider the asynchronous version .isEmpty.

count

abstract fun count(): Single<Int>

Get the count of elements in an asynchronous way, returning a Single.

get

abstract fun get(): Single<List<M>>

Get the objects in scope in an asynchronous way, returning a Single<List>.

getPaged

abstract fun ~~getPaged~~(pageSize: Int): LiveData<PagedList<M>>

Handy method to use in conjunction with PagedListAdapter to build paged lists.

getPagingData

abstract fun getPagingData(pageSize: Int): Flow<PagingData<M>>

Uses Paging3 library and return a Flow

getUids

abstract fun getUids(): Single<List<String>>

Get the list of uids of objects in scope in an asynchronous way, returning a Single<List<String>>.

isEmpty

abstract fun isEmpty(): Single<Boolean>

Check if selection of objects in current scope with applied filters is empty in an asynchronous way, returning a Single.

one

abstract fun one(): ReadOnlyObjectRepository<M>

Get a ReadOnlyObjectRepository pointing to the first element in the list.

uid

abstract fun uid(uid: String?): ReadOnlyObjectRepository<M>

Returns a new ReadOnlyObjectRepository whose scope is the one of the current repository plus the equal filter applied to the uid. This method is equivalent to byUid().eq(uid).one().