DHIS2 Android SDK/org.hisp.dhis.android.core.trackedentity/TrackedEntityInstanceCollectionRepository

TrackedEntityInstanceCollectionRepository

class TrackedEntityInstanceCollectionRepository : ReadWriteWithUidCollectionRepositoryImpl<TrackedEntityInstance, TrackedEntityInstanceCreateProjection, TrackedEntityInstanceCollectionRepository> , ReadWriteWithUploadWithUidCollectionRepository<TrackedEntityInstance, TrackedEntityInstanceCreateProjection>

Properties

dataSource

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

Functions

add

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

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.

blockingUpload

open override fun blockingUpload()

Uploads the resources 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 .upload. The method will finish as soon as the whole upload an processing is finished.

byAggregatedSyncState

fun byAggregatedSyncState(): EnumFilterConnector<TrackedEntityInstanceCollectionRepository, State>

byCreated

fun byCreated(): DateFilterConnector<TrackedEntityInstanceCollectionRepository>

byCreatedAtClient

fun byCreatedAtClient(): StringFilterConnector<TrackedEntityInstanceCollectionRepository>

byDeleted

fun byDeleted(): BooleanFilterConnector<TrackedEntityInstanceCollectionRepository>

byGeometryCoordinates

fun byGeometryCoordinates(): StringFilterConnector<TrackedEntityInstanceCollectionRepository>

byGeometryType

fun byGeometryType(): EnumFilterConnector<TrackedEntityInstanceCollectionRepository, FeatureType>

byLastUpdated

fun byLastUpdated(): DateFilterConnector<TrackedEntityInstanceCollectionRepository>

byLastUpdatedAtClient

fun byLastUpdatedAtClient(): StringFilterConnector<TrackedEntityInstanceCollectionRepository>

byOrganisationUnitUid

fun byOrganisationUnitUid(): StringFilterConnector<TrackedEntityInstanceCollectionRepository>

byProgramUids

fun byProgramUids(programUids: List<String>): TrackedEntityInstanceCollectionRepository

byState

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

bySyncState

fun bySyncState(): EnumFilterConnector<TrackedEntityInstanceCollectionRepository, State>

byTrackedEntityType

fun byTrackedEntityType(): StringFilterConnector<TrackedEntityInstanceCollectionRepository>

byUid

fun byUid(): StringFilterConnector<TrackedEntityInstanceCollectionRepository>

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<TrackedEntityInstance>>

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

getPaged

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

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

getPager

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

getPagingData

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

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<TrackedEntityInstance>

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

orderByCreated

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

orderByCreatedAtClient

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

orderByLastUpdated

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

orderByLastUpdatedAtClient

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

uid

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

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

upload

open override fun upload(): Observable<D2Progress>

Uploads the resources in scope in an asynchronous way. An Observable<D2Progress> is returned, which will emit progress until the whole upload is finished and the Observable is completed.

withProgramOwners

fun withProgramOwners(): TrackedEntityInstanceCollectionRepository

withTrackedEntityAttributeValues

fun withTrackedEntityAttributeValues(): TrackedEntityInstanceCollectionRepository