Serialized Form

Package org.hisp.dhis.auth

Class org.hisp.dhis.auth.AccessTokenAuthentication

class AccessTokenAuthentication extends Object implements Serializable

Serialized Fields

accessToken

@NonNull String accessToken

Class org.hisp.dhis.auth.BasicAuthentication

class BasicAuthentication extends Object implements Serializable

Serialized Fields

password

@NonNull String password

username

@NonNull String username

Class org.hisp.dhis.auth.CookieAuthentication

class CookieAuthentication extends Object implements Serializable

Serialized Fields

sessionId

@NonNull String sessionId

Package org.hisp.dhis.model

Class org.hisp.dhis.model.Attribute

class Attribute extends NameableObject implements Serializable

Class org.hisp.dhis.model.Category

class Category extends NameableObject implements Serializable

Serialized Fields

categoryCombos

Set<CategoryCombo> categoryCombos

categoryOptions

List<CategoryOption> categoryOptions

dataDimension

Boolean dataDimension

dataDimensionType

DataDimensionType dataDimensionType

Class org.hisp.dhis.model.CategoryCombo

class CategoryCombo extends NameableObject implements Serializable

Serialized Fields

categories

List<Category> categories

categoryOptionCombos

List<CategoryOptionCombo> categoryOptionCombos

dataDimensionType

DataDimensionType dataDimensionType

skipTotal

Boolean skipTotal

Class org.hisp.dhis.model.CategoryOption

class CategoryOption extends NameableObject implements Serializable

Serialized Fields

categories

Set<Category> categories

categoryOptionCombos

Set<CategoryOptionCombo> categoryOptionCombos

endDate

Date endDate

formName

String formName

organisationUnits

Set<OrgUnit> organisationUnits

startDate

Date startDate

Class org.hisp.dhis.model.CategoryOptionCombo

class CategoryOptionCombo extends NameableObject implements Serializable

Serialized Fields

categoryOptions

Set<CategoryOption> categoryOptions

ignoreApproval

Boolean ignoreApproval

Class org.hisp.dhis.model.CategoryOptionGroup

class CategoryOptionGroup extends NameableObject implements Serializable

Serialized Fields

categoryOptions

List<CategoryOption> categoryOptions

dataDimensionType

DataDimensionType dataDimensionType

dimensionItemType

DimensionItemType dimensionItemType

groupSets

List<CategoryOptionGroupSet> groupSets

Class org.hisp.dhis.model.CategoryOptionGroupSet

class CategoryOptionGroupSet extends NameableObject implements Serializable

Serialized Fields

categoryOptionGroups

List<CategoryOptionGroup> categoryOptionGroups

dataDimension

Boolean dataDimension

dataDimensionType

DataDimensionType dataDimensionType

Class org.hisp.dhis.model.DataApprovalWorkflow

class DataApprovalWorkflow extends NameableObject implements Serializable

Serialized Fields

dataSets

List<DataSet> dataSets

periodType

String periodType

Class org.hisp.dhis.model.DataElement

class DataElement extends NameableObject implements Serializable

Serialized Fields

aggregationType

AggregationType aggregationType

dataElementGroups

List<DataElementGroup> dataElementGroups

dataSetElements

List<DataSetElement> dataSetElements

domainType

DataDomain domainType

legendSets

List<LegendSet> legendSets

optionSet

OptionSet optionSet

url

String url

valueType

ValueType valueType

Class org.hisp.dhis.model.DataElementGroup

class DataElementGroup extends NameableObject implements Serializable

Serialized Fields

dataElements

List<DataElement> dataElements

groupSets

List<DataElementGroupSet> groupSets

Class org.hisp.dhis.model.DataElementGroupSet

class DataElementGroupSet extends NameableObject implements Serializable

Serialized Fields

compulsory

Boolean compulsory

dataDimension

Boolean dataDimension

dataDimensionType

DataDimensionType dataDimensionType

dataElementGroups

List<DataElementGroup> dataElementGroups

Class org.hisp.dhis.model.DataEntryForm

class DataEntryForm extends NameableObject implements Serializable

Serialized Fields

format

Integer format

htmlCode

String htmlCode

style

FormStyle style

Class org.hisp.dhis.model.DataSet

class DataSet extends NameableObject implements Serializable

Serialized Fields

aggregationType

AggregationType aggregationType

categoryCombo

CategoryCombo categoryCombo

compulsoryFieldsCompleteOnly

Boolean compulsoryFieldsCompleteOnly

dataElementDecoration

Boolean dataElementDecoration

dataEntryForm

DataEntryForm dataEntryForm

dataSetElements

List<DataSetElement> dataSetElements

dimensionItem

String dimensionItem

dimensionItemType

DimensionItemType dimensionItemType

displayFormName

String displayFormName

expiryDays

Integer expiryDays

favorite

Boolean favorite

fieldCombinationRequired

Boolean fieldCombinationRequired

formName

String formName

formType

FormType formType

indicators

List<Indicator> indicators

legendSets

List<LegendSet> legendSets

mobile

Boolean mobile

notifyCompletingUser

Boolean notifyCompletingUser

noValueRequiresComment

Boolean noValueRequiresComment

openFuturePeriods

Integer openFuturePeriods

openPeriodsAfterCoEndDate

Integer openPeriodsAfterCoEndDate

organisationUnits

List<OrgUnit> organisationUnits

periodType

String periodType

sections

List<Section> sections

skipOffline

Boolean skipOffline

timelyDays

Integer timelyDays

url

String url

validCompleteOnly

Boolean validCompleteOnly

version

Integer version

workflow

DataApprovalWorkflow workflow

Class org.hisp.dhis.model.Dimension

class Dimension extends IdentifiableObject implements Serializable

Serialized Fields

dimensionType

DimensionType dimensionType

shortName

String shortName

Class org.hisp.dhis.model.FileResource

class FileResource extends NameableObject implements Serializable

Serialized Fields

contentLength

Integer contentLength

contentMd5

String contentMd5

contentType

String contentType

domain

String domain

hasMultipleStorageFiles

String hasMultipleStorageFiles

storageStatus

String storageStatus

Class org.hisp.dhis.model.GeoMap

class GeoMap extends NameableObject implements Serializable

Class org.hisp.dhis.model.IdentifiableObject

class IdentifiableObject extends Object implements Serializable

Serialized Fields

attributeValues

Set<AttributeValue> attributeValues

code

String code

created

Date created

id

String id

lastUpdated

Date lastUpdated

name

String name

Class org.hisp.dhis.model.Indicator

class Indicator extends NameableObject implements Serializable

Serialized Fields

annualized

boolean annualized

denominator

String denominator

denominatorDescription

String denominatorDescription

indicatorType

IndicatorType indicatorType

numerator

String numerator

numeratorDescription

String numeratorDescription

url

String url

Class org.hisp.dhis.model.IndicatorGroup

class IndicatorGroup extends NameableObject implements Serializable

Serialized Fields

groupSets

List<IndicatorGroupSet> groupSets

indicators

List<Indicator> indicators

Class org.hisp.dhis.model.IndicatorGroupSet

class IndicatorGroupSet extends NameableObject implements Serializable

Serialized Fields

compulsory

Boolean compulsory

indicatorGroups

List<IndicatorGroup> indicatorGroups

Class org.hisp.dhis.model.IndicatorType

class IndicatorType extends NameableObject implements Serializable

Serialized Fields

factor

Integer factor

number

Boolean number

Class org.hisp.dhis.model.LegendSet

class LegendSet extends NameableObject implements Serializable

Class org.hisp.dhis.model.Me

class Me extends IdentifiableObject implements Serializable

Serialized Fields

authorities

Set<String> authorities

dataSets

Set<String> dataSets

email

String email

firstName

String firstName

organisationUnits

Set<OrgUnit> organisationUnits

programs

Set<String> programs

settings

UserSettings settings

surname

String surname

username

String username

Class org.hisp.dhis.model.NameableObject

class NameableObject extends IdentifiableObject implements Serializable

Serialized Fields

description

String description

shortName

String shortName

Class org.hisp.dhis.model.Option

class Option extends NameableObject implements Serializable

Class org.hisp.dhis.model.OptionSet

class OptionSet extends IdentifiableObject implements Serializable

Serialized Fields

name

String name

options

List<Option> options

valueType

ValueType valueType

version

String version

Class org.hisp.dhis.model.OrgUnit

class OrgUnit extends NameableObject implements Serializable

Serialized Fields

address

String address

closedDate

Date closedDate

comment

String comment

contactPerson

String contactPerson

email

String email

level

Integer level

openingDate

Date openingDate

parent

OrgUnit parent

path

String path

phoneNumber

String phoneNumber

url

String url

Class org.hisp.dhis.model.OrgUnitGroup

class OrgUnitGroup extends NameableObject implements Serializable

Serialized Fields

orgUnits

List<OrgUnit> orgUnits

Class org.hisp.dhis.model.OrgUnitGroupSet

class OrgUnitGroupSet extends NameableObject implements Serializable

Serialized Fields

compulsory

Boolean compulsory

dataDimension

Boolean dataDimension

organisationUnitGroups

Set<OrgUnitGroup> organisationUnitGroups

Class org.hisp.dhis.model.OrgUnitLevel

class OrgUnitLevel extends IdentifiableObject implements Serializable

Serialized Fields

level

int level

Class org.hisp.dhis.model.Program

class Program extends NameableObject implements Serializable

Serialized Fields

categoryCombo

CategoryCombo categoryCombo

programStages

List<ProgramStage> programStages

programTrackedEntityAttributes

List<ProgramTrackedEntityAttribute> programTrackedEntityAttributes

programType

ProgramType programType

trackedEntityType

TrackedEntityType trackedEntityType

Only relevant for ProgramType.WITH_REGISTRATION, null for ProgramType.WITHOUT_REGISTRATION.

Class org.hisp.dhis.model.ProgramIndicator

class ProgramIndicator extends NameableObject implements Serializable

Class org.hisp.dhis.model.ProgramStage

class ProgramStage extends NameableObject implements Serializable

Serialized Fields

programStageDataElements

List<ProgramStageDataElement> programStageDataElements

Class org.hisp.dhis.model.ProgramStageDataElement

class ProgramStageDataElement extends NameableObject implements Serializable

Serialized Fields

compulsory

Boolean compulsory

dataElement

DataElement dataElement

displayInReports

Boolean displayInReports

skipAnalytics

Boolean skipAnalytics

skipSynchronization

Boolean skipSynchronization

Class org.hisp.dhis.model.Section

class Section extends NameableObject implements Serializable

Serialized Fields

dataElements

List<DataElement> dataElements

dataSet

DataSet dataSet

indicators

List<Indicator> indicators

Class org.hisp.dhis.model.SystemVersion

class SystemVersion extends Object implements Serializable

Serialized Fields

version

String version

Class org.hisp.dhis.model.TableHook

class TableHook extends IdentifiableObject implements Serializable

Serialized Fields

analyticsTableType

TableHook.AnalyticsTableType analyticsTableType

phase

TableHook.TablePhase phase

resourceTableType

TableHook.ResourceTableType resourceTableType

sql

String sql

Class org.hisp.dhis.model.Visualization

class Visualization extends NameableObject implements Serializable

Package org.hisp.dhis.model.dashboard

Class org.hisp.dhis.model.dashboard.Dashboard

class Dashboard extends NameableObject implements Serializable

Serialized Fields

embedded

EmbeddedDashboard embedded

Optional, only set if this dashboard is embedded and loaded from an external provider.

Since:

DHIS 2.42.

Class org.hisp.dhis.model.dashboard.EmbeddedDashboard

class EmbeddedDashboard extends Object implements Serializable

Serialized Fields

id

String id

Identifier for embedded dashboard.

options

EmbeddedOptions options

Customization options for embedded dashboard.

provider

EmbeddedProvider provider

Provider of embedded dashboards.

Class org.hisp.dhis.model.dashboard.EmbeddedOptions

class EmbeddedOptions extends Object implements Serializable

Serialized Fields

filters

FilterOptions filters

Filter options. Applies to Superset.

hideChartControls

boolean hideChartControls

Hide the chart controls. Applies to Superset.

hideTab

boolean hideTab

Hide tab. Applies to Superset.

Class org.hisp.dhis.model.dashboard.FilterOptions

class FilterOptions extends Object implements Serializable

Serialized Fields

expanded

boolean expanded

Whether filter sidebar should be expanded when opening the dashboard.

visible

boolean visible

Whether filter sidebar should be accessible when opening the dashboard.

Package org.hisp.dhis.model.datavalueset

Class org.hisp.dhis.model.datavalueset.DataValue

class DataValue extends Object implements Serializable

Serialized Fields

attributeOptionCombo

String attributeOptionCombo

categoryOptionCombo

String categoryOptionCombo

comment

String comment

created

String created

dataElement

String dataElement

deleted

Boolean deleted

followup

Boolean followup

lastUpdated

String lastUpdated

orgUnit

String orgUnit

period

String period

storedBy

String storedBy

value

String value

Class org.hisp.dhis.model.datavalueset.DataValueSet

class DataValueSet extends Object implements Serializable

Serialized Fields

attributeOptionCombo

String attributeOptionCombo

completeDate

String completeDate

dataSet

String dataSet

dataValues

List<DataValue> dataValues

orgUnit

String orgUnit

period

String period

Class org.hisp.dhis.model.datavalueset.DataValueSetImportOptions

class DataValueSetImportOptions extends Object implements Serializable

Serialized Fields

categoryOptionComboIdScheme

IdScheme categoryOptionComboIdScheme

dataElementIdScheme

IdScheme dataElementIdScheme

dryRun

Boolean dryRun

idScheme

IdScheme idScheme

orgUnitIdScheme

IdScheme orgUnitIdScheme

preheatCache

Boolean preheatCache

skipAudit

Boolean skipAudit

Package org.hisp.dhis.model.event

Class org.hisp.dhis.model.event.Event

class Event extends Object implements Serializable

Serialized Fields

attributeOptionCombo

String attributeOptionCombo

Default.

completedAt

Date completedAt

completedBy

String completedBy

Read-only.

createdAt

Date createdAt

Read-only.

createdAtClient

Date createdAtClient

dataValues

List<EventDataValue> dataValues

deleted

Boolean deleted

Read-only.

followUp

Boolean followUp

Read-only.

geometry

org.locationtech.jts.geom.Geometry geometry

id

String id

occurredAt

Date occurredAt

orgUnit

String orgUnit

program

String program

Read-only.

programStage

String programStage

scheduledAt

Date scheduledAt

status

EventStatus status

storedBy

String storedBy

trackedEntity

String trackedEntity

Read-only.

updatedAt

Date updatedAt

Read-only.

updatedAtClient

Date updatedAtClient

Class org.hisp.dhis.model.event.EventDataValue

class EventDataValue extends Object implements Serializable

Serialized Fields

createdAt

Date createdAt

Read-only.

createdBy

String createdBy

Read-only.

dataElement

String dataElement

providedElsewhere

Boolean providedElsewhere

Default false.

storedBy

String storedBy

updatedAt

Date updatedAt

Read-only.

updatedBy

String updatedBy

Read-only.

value

String value

Class org.hisp.dhis.model.event.Events

class Events extends Object implements Serializable

Serialized Fields

events

List<Event> events

Class org.hisp.dhis.model.event.EventsResult

class EventsResult extends Object implements Serializable

Serialized Fields

events

List<Event> events

Package org.hisp.dhis.model.trackedentity

Class org.hisp.dhis.model.trackedentity.ProgramTrackedEntityAttribute

class ProgramTrackedEntityAttribute extends IdentifiableObject implements Serializable

Serialized Fields

trackedEntityAttribute

TrackedEntityAttribute trackedEntityAttribute

Class org.hisp.dhis.model.trackedentity.TrackedEntityAttribute

class TrackedEntityAttribute extends NameableObject implements Serializable

Serialized Fields

confidential

Boolean confidential

unique

Boolean unique

valueType

ValueType valueType

Class org.hisp.dhis.model.trackedentity.TrackedEntityType

class TrackedEntityType extends NameableObject implements Serializable

Serialized Fields

trackedEntityTypeAttributes

List<TrackedEntityTypeAttribute> trackedEntityTypeAttributes

Package org.hisp.dhis.model.validation

Class org.hisp.dhis.model.validation.Period

class Period extends IdentifiableObject implements Serializable

Class org.hisp.dhis.model.validation.ValidationRule

class ValidationRule extends NameableObject implements Serializable

Serialized Fields

dimensionItem

String dimensionItem

displayDescription

String displayDescription

displayInstruction

String displayInstruction

displayName

String displayName

importance

String importance

instruction

String instruction

leftSide

ValidationSide leftSide

legendSets

List<LegendSet> legendSets

operator

String operator

periodType

String periodType

rightSide

ValidationSide rightSide

skipFormValidation

Boolean skipFormValidation

Package org.hisp.dhis.response

Exception org.hisp.dhis.response.Dhis2ClientException

class Dhis2ClientException extends RuntimeException implements Serializable

Serialized Fields

statusCode

int statusCode