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

EnrollmentCollectionRepository

class EnrollmentCollectionRepository : ReadWriteWithUidCollectionRepositoryImpl<Enrollment, EnrollmentCreateProjection, EnrollmentCollectionRepository>

Properties

dataSource

val ~~dataSource~~: DataSource<Enrollment, Enrollment>

Functions

add

open override fun add(o: EnrollmentCreateProjection): 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

open override fun blockingAdd(o: EnrollmentCreateProjection): 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

open override 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

open override fun blockingGet(): List<Enrollment>

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

open override 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

open override 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.

byAggregatedSyncState

fun byAggregatedSyncState(): EnumFilterConnector<EnrollmentCollectionRepository, State>

byCreated

fun byCreated(): DateFilterConnector<EnrollmentCollectionRepository>

byCreatedAtClient

fun byCreatedAtClient(): StringFilterConnector<EnrollmentCollectionRepository>

byDeleted

fun byDeleted(): BooleanFilterConnector<EnrollmentCollectionRepository>

byEnrollmentDate

fun byEnrollmentDate(): DateFilterConnector<EnrollmentCollectionRepository>

byFollowUp

fun byFollowUp(): BooleanFilterConnector<EnrollmentCollectionRepository>

byGeometryCoordinates

fun byGeometryCoordinates(): StringFilterConnector<EnrollmentCollectionRepository>

byGeometryType

fun byGeometryType(): EnumFilterConnector<EnrollmentCollectionRepository, FeatureType>

byIncidentDate

fun byIncidentDate(): DateFilterConnector<EnrollmentCollectionRepository>

byLastUpdated

fun byLastUpdated(): DateFilterConnector<EnrollmentCollectionRepository>

byLastUpdatedAtClient

fun byLastUpdatedAtClient(): StringFilterConnector<EnrollmentCollectionRepository>

byOrganisationUnit

fun byOrganisationUnit(): StringFilterConnector<EnrollmentCollectionRepository>

byProgram

fun byProgram(): StringFilterConnector<EnrollmentCollectionRepository>

byState

fun ~~byState~~(): EnumFilterConnector<EnrollmentCollectionRepository, State>

Use .byAggregatedSyncState instead.

byStatus

fun byStatus(): EnumFilterConnector<EnrollmentCollectionRepository, EnrollmentStatus>

bySyncState

fun bySyncState(): EnumFilterConnector<EnrollmentCollectionRepository, State>

byTrackedEntityInstance

fun byTrackedEntityInstance(): StringFilterConnector<EnrollmentCollectionRepository>

byUid

fun byUid(): StringFilterConnector<EnrollmentCollectionRepository>

count

open override fun count(): Single<Int>

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

get

open override fun get(): Single<List<Enrollment>>

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

getPaged

open override fun ~~getPaged~~(pageSize: Int): LiveData<PagedList<Enrollment>>

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

getPager

fun getPager(pageSize: Int): Pager<Enrollment, Enrollment>

getPagingData

open override fun getPagingData(pageSize: Int): Flow<PagingData<Enrollment>>

Uses Paging3 library and return a Flow

getUids

open override fun getUids(): Single<List<String>>

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

isEmpty

open override 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

open override fun one(): ReadOnlyOneObjectRepositoryFinalImpl<Enrollment>

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

orderByCreated

fun orderByCreated(direction: RepositoryScope.OrderByDirection?): EnrollmentCollectionRepository

orderByCreatedAtClient

fun orderByCreatedAtClient(direction: RepositoryScope.OrderByDirection?): EnrollmentCollectionRepository

orderByEnrollmentDate

fun orderByEnrollmentDate(direction: RepositoryScope.OrderByDirection?): EnrollmentCollectionRepository

orderByIncidentDate

fun orderByIncidentDate(direction: RepositoryScope.OrderByDirection?): EnrollmentCollectionRepository

orderByLastUpdated

fun orderByLastUpdated(direction: RepositoryScope.OrderByDirection?): EnrollmentCollectionRepository

orderByLastUpdatedAtClient

fun orderByLastUpdatedAtClient(direction: RepositoryScope.OrderByDirection?): EnrollmentCollectionRepository

uid

open override fun uid(uid: String?): EnrollmentObjectRepository

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().

withNotes

fun withNotes(): EnrollmentCollectionRepository