DHIS2 Android SDK/org.hisp.dhis.android.core.event/EventService

EventService

interface EventService

Functions

blockingCanAddEventToEnrollment

abstract fun blockingCanAddEventToEnrollment(enrollmentUid: String, programStageUid: String): Boolean

Blocking version of canAddEventToEnrollment.

blockingGetEditableStatus

abstract fun blockingGetEditableStatus(eventUid: String): EventEditableStatus

Blocking version of getEditableStatus.

blockingHasCategoryComboAccess

abstract fun blockingHasCategoryComboAccess(event: Event): Boolean

Blocking version of hasCategoryComboAccess.

blockingHasDataWriteAccess

abstract fun blockingHasDataWriteAccess(eventUid: String): Boolean

Blocking version of hasDataWriteAccess.

blockingIsEditable

abstract fun blockingIsEditable(eventUid: String): Boolean

Blocking version of isEditable.

blockingIsInOrgunitRange

abstract fun blockingIsInOrgunitRange(event: Event): Boolean

Blocking version of isInOrgunitRange.

canAddEventToEnrollment

abstract fun canAddEventToEnrollment(enrollmentUid: String, programStageUid: String): Single<Boolean>

Evaluates if an enrollments accepts more events for a particular programStage.

getEditableStatus

abstract fun getEditableStatus(eventUid: String): Single<EventEditableStatus>

Returns the editable status of an event. In case the event is not editable, the result also includes the reason why it is not editable.

hasCategoryComboAccess

abstract fun hasCategoryComboAccess(event: Event): Single<Boolean>

Check if user has access to the categoryCombo linked to the event and also if the categoryCombo is active in the event date.

hasDataWriteAccess

abstract fun hasDataWriteAccess(eventUid: String): Single<Boolean>

Check if user has data write access to a particular event.

abstract fun isEditable(eventUid: String): Single<Boolean>

Check if the event can be edited or not. If you want to know the reason why the event is not editable, check the method getEditableStatus for a richer description of the status.

isInOrgunitRange

abstract fun isInOrgunitRange(event: Event): Single<Boolean>

Check if the event has the event date within the opening period of the assigned organisation unit.