DHIS2 Android SDK/org.hisp.dhis.android.core.event.search/EventQueryCollectionRepository

EventQueryCollectionRepository

class EventQueryCollectionRepository : ReadOnlyWithUidCollectionRepository<Event>

Properties

dataSource

val dataSource: DataSource<Event, Event>

scope

@JvmField

val scope: EventQueryRepositoryScope

Functions

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

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.

byAssignedUser

fun byAssignedUser(): EqFilterConnector<EventQueryCollectionRepository, AssignedUserMode>

byAttributeOptionCombo

fun byAttributeOptionCombo(): ListFilterConnector<EventQueryCollectionRepository, String>

byCompleteDate

fun byCompleteDate(): PeriodFilterConnector<EventQueryCollectionRepository>

byDataValue

fun byDataValue(dataElementId: String): EventDataFilterConnector<EventQueryCollectionRepository>

byDueDate

fun byDueDate(): PeriodFilterConnector<EventQueryCollectionRepository>

byEventDate

fun byEventDate(): PeriodFilterConnector<EventQueryCollectionRepository>

byEventFilter

fun byEventFilter(): EqFilterConnector<EventQueryCollectionRepository, String>

byIncludeDeleted

fun byIncludeDeleted(): EqFilterConnector<EventQueryCollectionRepository, Boolean>

byLastUpdated

fun byLastUpdated(): PeriodFilterConnector<EventQueryCollectionRepository>

byOrgUnitMode

fun byOrgUnitMode(): EqFilterConnector<EventQueryCollectionRepository, OrganisationUnitMode>

byOrgUnits

fun byOrgUnits(): ListFilterConnector<EventQueryCollectionRepository, String>

Filter by Event organisation units.

IMPORTANT: this filter accepts a list of organisation units, but only the first one will be used for the online query because the web API does not support querying by multiple organisation units.

byProgram

fun byProgram(): EqFilterConnector<EventQueryCollectionRepository, String>

byProgramStage

fun byProgramStage(): EqFilterConnector<EventQueryCollectionRepository, String>

byStates

fun byStates(): ListFilterConnector<EventQueryCollectionRepository, State>

Filter by sync status.

IMPORTANT: using this filter forces offlineOnly mode.

byStatus

fun byStatus(): ListFilterConnector<EventQueryCollectionRepository, EventStatus>

Filter by event status.

IMPORTANT: this filter accepts a list of event status, but only the first one will be used for the online query because the web API does not support querying by multiple status.

byTrackedEntityInstance

fun byTrackedEntityInstance(): EqFilterConnector<EventQueryCollectionRepository, String>

byUid

fun byUid(): ListFilterConnector<EventQueryCollectionRepository, String>

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

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

getPaged

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

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

getPager

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

getPagingData

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

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(): ReadOnlyObjectRepository<Event>

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

orderByCompleteDate

fun orderByCompleteDate(): EqFilterConnector<EventQueryCollectionRepository, RepositoryScope.OrderByDirection>

orderByCreated

fun orderByCreated(): EqFilterConnector<EventQueryCollectionRepository, RepositoryScope.OrderByDirection>

orderByDataElement

fun orderByDataElement(dataElement: String?): EqFilterConnector<EventQueryCollectionRepository, RepositoryScope.OrderByDirection>

orderByDueDate

fun orderByDueDate(): EqFilterConnector<EventQueryCollectionRepository, RepositoryScope.OrderByDirection>

orderByEventDate

fun orderByEventDate(): EqFilterConnector<EventQueryCollectionRepository, RepositoryScope.OrderByDirection>

orderByLastUpdated

fun orderByLastUpdated(): EqFilterConnector<EventQueryCollectionRepository, RepositoryScope.OrderByDirection>

orderByOrganisationUnitName

fun orderByOrganisationUnitName(): EqFilterConnector<EventQueryCollectionRepository, RepositoryScope.OrderByDirection>

orderByTimeline

fun orderByTimeline(): EqFilterConnector<EventQueryCollectionRepository, RepositoryScope.OrderByDirection>

uid

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

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