rule-engine/org.hisp.dhis.rules.models

Package-level declarations

Types

enum AttributeType : Enum<AttributeType>

This Enum specify the type of the id saved in the field of a RuleAction.

data class Option(val name: String, val code: String)

data class Rule(val condition: String, val actions: List<RuleAction>, val uid: String = "", val name: String? = null, val programStage: String? = null, val priority: Int? = null) : Comparable<Rule>

RuleAction

data class RuleAction(val data: String?, val type: String, val values: Map<String, String> = emptyMap())

RuleAttributeValue

data class RuleAttributeValue(val trackedEntityAttribute: String, val value: String)

RuleDataValue

data class RuleDataValue(val dataElement: String, val value: String)

RuleDataValueHistory

data class RuleDataValueHistory(val value: String, val eventDate: Instant, val createdDate: Instant, val programStage: String)

RuleEffect

data class RuleEffect(val ruleId: String, val ruleAction: RuleAction, val data: String? = "")

RuleEffects

data class RuleEffects(val trackerObjectType: TrackerObjectType, val trackerObjectUid: String, val ruleEffects: List<RuleEffect>)

RuleEngineValidationException

class RuleEngineValidationException(cause: IllegalArgumentException) : IllegalArgumentException

RuleEnrollment

data class RuleEnrollment(val enrollment: String, val programName: String, val incidentDate: LocalDate, val enrollmentDate: LocalDate, val status: RuleEnrollmentStatus, val organisationUnit: String, val organisationUnitCode: String?, val attributeValues: List<RuleAttributeValue>)

RuleEnrollmentStatus

enum RuleEnrollmentStatus : Enum<RuleEnrollmentStatus>

RuleEvent

data class RuleEvent(val event: String, val programStage: String, val programStageName: String, val status: RuleEventStatus, val eventDate: Instant, val createdDate: Instant, val dueDate: LocalDate?, val completedDate: LocalDate?, val organisationUnit: String, val organisationUnitCode: String?, val dataValues: List<RuleDataValue>)

RuleEventStatus

enum RuleEventStatus : Enum<RuleEventStatus>

RuleValidationResult

data class RuleValidationResult(val valid: Boolean, val errorMessage: String? = null, val exception: Throwable? = null, val description: String? = null)

RuleValueType

enum RuleValueType : Enum<RuleValueType>

RuleVariable

interface RuleVariable

RuleVariableAttribute

data class RuleVariableAttribute(val name: String, val useCodeForOptionSet: Boolean, val options: List<Option>, val field: String, val fieldType: RuleValueType) : RuleVariable

RuleVariableCalculatedValue

class RuleVariableCalculatedValue(val name: String, val useCodeForOptionSet: Boolean, val options: List<Option>, val field: String, val fieldType: RuleValueType) : RuleVariable

RuleVariableCurrentEvent

class RuleVariableCurrentEvent(val name: String, val useCodeForOptionSet: Boolean, val options: List<Option>, val field: String, val fieldType: RuleValueType) : RuleVariable

RuleVariableNewestEvent

class RuleVariableNewestEvent(val name: String, val useCodeForOptionSet: Boolean, val options: List<Option>, val field: String, val fieldType: RuleValueType) : RuleVariable

RuleVariableNewestStageEvent

class RuleVariableNewestStageEvent(val name: String, val useCodeForOptionSet: Boolean, val options: List<Option>, val field: String, val fieldType: RuleValueType, val programStage: String) : RuleVariable

RuleVariablePreviousEvent

class RuleVariablePreviousEvent(val name: String, val useCodeForOptionSet: Boolean, val options: List<Option>, val field: String, val fieldType: RuleValueType) : RuleVariable

TrackerObjectType

enum TrackerObjectType : Enum<TrackerObjectType>

This Enum specify the type of tracker object.

TriggerEnvironment

enum TriggerEnvironment : Enum<TriggerEnvironment>