DHIS2 Android SDK/org.hisp.dhis.android.core.program/Program

Program

data class Program(val uid: String, val code: String?, val name: String?, val displayName: String?, val created: Date?, val lastUpdated: Date?, val deleted: Boolean?, val shortName: String?, val displayShortName: String?, val description: String?, val displayDescription: String?, val version: Int?, val onlyEnrollOnce: Boolean?, val displayEnrollmentDateLabel: String?, val displayIncidentDate: Boolean?, val displayIncidentDateLabel: String?, val registration: Boolean?, val selectEnrollmentDatesInFuture: Boolean?, val dataEntryMethod: Boolean?, val ignoreOverdueEvents: Boolean?, val selectIncidentDatesInFuture: Boolean?, val useFirstStageDuringRegistration: Boolean?, val displayFrontPageList: Boolean?, val programType: ProgramType?, programTrackedEntityAttributes: List<ProgramTrackedEntityAttribute>?, val relatedProgram: ObjectWithUid?, val trackedEntityType: TrackedEntityType?, val categoryCombo: ObjectWithUid, val access: Access, programRuleVariables: List<ProgramRuleVariable>?, val expiryDays: Int?, val completeEventsExpiryDays: Int?, val expiryPeriodType: PeriodType?, val minAttributesRequiredToSearch: Int?, val maxTeiCountToReturn: Int?, programSections: List<ProgramSection>?, val featureType: FeatureType?, val accessLevel: AccessLevel?, val displayEnrollmentLabel: String?, val displayEnrollmentsLabel: String?, val displayFollowUpLabel: String?, val displayOrgUnitLabel: String?, val displayRelationshipLabel: String?, val displayRelationshipsLabel: String?, val displayNoteLabel: String?, val displayTrackedEntityAttributeLabel: String?, val displayProgramStageLabel: String?, val displayProgramStagesLabel: String?, val displayEventLabel: String?, val displayEventsLabel: String?, val attributeValues: List<AttributeValue>?, val enrollmentCategoryCombo: ObjectWithUid, categoryMappings: List<CategoryMapping>?, val style: ObjectStyle) : BaseNameableObject, CoreObject, ObjectWithStyleKt

Constructors

constructor(uid: String, code: String?, name: String?, displayName: String?, created: Date?, lastUpdated: Date?, deleted: Boolean?, shortName: String?, displayShortName: String?, description: String?, displayDescription: String?, version: Int?, onlyEnrollOnce: Boolean?, displayEnrollmentDateLabel: String?, displayIncidentDate: Boolean?, displayIncidentDateLabel: String?, registration: Boolean?, selectEnrollmentDatesInFuture: Boolean?, dataEntryMethod: Boolean?, ignoreOverdueEvents: Boolean?, selectIncidentDatesInFuture: Boolean?, useFirstStageDuringRegistration: Boolean?, displayFrontPageList: Boolean?, programType: ProgramType?, programTrackedEntityAttributes: List<ProgramTrackedEntityAttribute>?, relatedProgram: ObjectWithUid?, trackedEntityType: TrackedEntityType?, categoryCombo: ObjectWithUid, access: Access, programRuleVariables: List<ProgramRuleVariable>?, expiryDays: Int?, completeEventsExpiryDays: Int?, expiryPeriodType: PeriodType?, minAttributesRequiredToSearch: Int?, maxTeiCountToReturn: Int?, programSections: List<ProgramSection>?, featureType: FeatureType?, accessLevel: AccessLevel?, displayEnrollmentLabel: String?, displayEnrollmentsLabel: String?, displayFollowUpLabel: String?, displayOrgUnitLabel: String?, displayRelationshipLabel: String?, displayRelationshipsLabel: String?, displayNoteLabel: String?, displayTrackedEntityAttributeLabel: String?, displayProgramStageLabel: String?, displayProgramStagesLabel: String?, displayEventLabel: String?, displayEventsLabel: String?, attributeValues: List<AttributeValue>?, enrollmentCategoryCombo: ObjectWithUid, categoryMappings: List<CategoryMapping>?, style: ObjectStyle)

Types

class Builder : ProgramBuilder

object Companion

Properties

val access: Access

val accessLevel: AccessLevel?

attributeValues

val attributeValues: List<AttributeValue>?

val categoryCombo: ObjectWithUid

open override val code: String?

completeEventsExpiryDays

val completeEventsExpiryDays: Int?

open override val created: Date?

dataEntryMethod

val dataEntryMethod: Boolean?

open override val deleted: Boolean?

open override val description: String?

displayDescription

open override val displayDescription: String?

displayEnrollmentDateLabel

val displayEnrollmentDateLabel: String?

displayEnrollmentLabel

val displayEnrollmentLabel: String?

displayEnrollmentsLabel

val displayEnrollmentsLabel: String?

displayEventLabel

val displayEventLabel: String?

displayEventsLabel

val displayEventsLabel: String?

displayFollowUpLabel

val displayFollowUpLabel: String?

displayFrontPageList

val displayFrontPageList: Boolean?

displayIncidentDate

val displayIncidentDate: Boolean?

displayIncidentDateLabel

val displayIncidentDateLabel: String?

open override val displayName: String?

displayNoteLabel

val displayNoteLabel: String?

displayOrgUnitLabel

val displayOrgUnitLabel: String?

displayProgramStageLabel

val displayProgramStageLabel: String?

displayProgramStagesLabel

val displayProgramStagesLabel: String?

displayRelationshipLabel

val displayRelationshipLabel: String?

displayRelationshipsLabel

val displayRelationshipsLabel: String?

displayShortName

open override val displayShortName: String?

displayTrackedEntityAttributeLabel

val displayTrackedEntityAttributeLabel: String?

enrollmentCategoryCombo

val enrollmentCategoryCombo: ObjectWithUid

val expiryDays: Int?

expiryPeriodType

val expiryPeriodType: PeriodType?

val featureType: FeatureType?

ignoreOverdueEvents

val ignoreOverdueEvents: Boolean?

open override val lastUpdated: Date?

maxTeiCountToReturn

val maxTeiCountToReturn: Int?

minAttributesRequiredToSearch

val minAttributesRequiredToSearch: Int?

open override val name: String?

val onlyEnrollOnce: Boolean?

val programType: ProgramType?

val registration: Boolean?

val relatedProgram: ObjectWithUid?

selectEnrollmentDatesInFuture

val selectEnrollmentDatesInFuture: Boolean?

selectIncidentDatesInFuture

val selectIncidentDatesInFuture: Boolean?

open override val shortName: String?

open override val style: ObjectStyle

trackedEntityType

val trackedEntityType: TrackedEntityType?

open override val uid: String

useFirstStageDuringRegistration

val useFirstStageDuringRegistration: Boolean?

val version: Int?

Functions

fun access(): Access

fun accessLevel(): AccessLevel?

attributeValues

fun attributeValues(): List<AttributeValue>?

fun categoryCombo(): ObjectWithUid

open override fun code(): String?

completeEventsExpiryDays

fun completeEventsExpiryDays(): Int?

open override fun created(): Date?

dataEntryMethod

fun dataEntryMethod(): Boolean?

open override fun deleted(): Boolean?

open override fun description(): String?

displayDescription

open override fun displayDescription(): String?

displayEnrollmentDateLabel

fun displayEnrollmentDateLabel(): String?

displayEnrollmentLabel

fun displayEnrollmentLabel(): String?

displayEnrollmentsLabel

fun displayEnrollmentsLabel(): String?

displayEventLabel

fun displayEventLabel(): String?

displayEventsLabel

fun displayEventsLabel(): String?

displayFollowUpLabel

fun displayFollowUpLabel(): String?

displayFrontPageList

fun displayFrontPageList(): Boolean?

displayIncidentDate

fun displayIncidentDate(): Boolean?

displayIncidentDateLabel

fun displayIncidentDateLabel(): String?

open override fun displayName(): String?

displayNoteLabel

fun displayNoteLabel(): String?

displayOrgUnitLabel

fun displayOrgUnitLabel(): String?

displayProgramStageLabel

fun displayProgramStageLabel(): String?

displayProgramStagesLabel

fun displayProgramStagesLabel(): String?

displayRelationshipLabel

fun displayRelationshipLabel(): String?

displayRelationshipsLabel

fun displayRelationshipsLabel(): String?

displayShortName

open override fun displayShortName(): String?

displayTrackedEntityAttributeLabel

fun displayTrackedEntityAttributeLabel(): String?

enrollmentCategoryCombo

fun enrollmentCategoryCombo(): ObjectWithUid

enrollmentDateLabel

fun ~~enrollmentDateLabel~~(): String?

enrollmentLabel

fun ~~enrollmentLabel~~(): String?

fun ~~eventLabel~~(): String?

fun expiryDays(): Int?

expiryPeriodType

fun expiryPeriodType(): PeriodType?

fun featureType(): FeatureType?

fun ~~followUpLabel~~(): String?

ignoreOverdueEvents

fun ignoreOverdueEvents(): Boolean?

incidentDateLabel

fun ~~incidentDateLabel~~(): String?

open override fun lastUpdated(): Date?

maxTeiCountToReturn

fun maxTeiCountToReturn(): Int?

minAttributesRequiredToSearch

fun minAttributesRequiredToSearch(): Int?

open override fun name(): String?

fun ~~noteLabel~~(): String?

fun onlyEnrollOnce(): Boolean?

fun ~~orgUnitLabel~~(): String?

programStageLabel

fun ~~programStageLabel~~(): String?

fun programType(): ProgramType?

fun registration(): Boolean?

fun relatedProgram(): ObjectWithUid?

relationshipLabel

fun ~~relationshipLabel~~(): String?

selectEnrollmentDatesInFuture

fun selectEnrollmentDatesInFuture(): Boolean?

selectIncidentDatesInFuture

fun selectIncidentDatesInFuture(): Boolean?

open override fun shortName(): String?

open override fun style(): ObjectStyle

fun toBuilder(): Program.Builder

trackedEntityAttributeLabel

fun ~~trackedEntityAttributeLabel~~(): String?

trackedEntityType

fun trackedEntityType(): TrackedEntityType?

open override fun uid(): String

useFirstStageDuringRegistration

fun useFirstStageDuringRegistration(): Boolean?

fun version(): Int?