Package org.hisp.dhis

Class Dhis2

java.lang.Object

org.hisp.dhis.BaseDhis2

org.hisp.dhis.Dhis2

public class Dhis2
extends BaseDhis2

DHIS 2 API client for HTTP requests and responses. Request and response bodies are in JSON format. Client is tread-safe and suitable for reuse.

Methods generally throw Dhis2ClientException for status code 401, 403 and 404 in HTTP responses.

Author:

Lars Helge Overland

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUPER_AUTH	Authority which provides superuser authorization in DHIS 2.

Fields inherited from class org.hisp.dhis.BaseDhis2

CATEGORY_COMBO_FIELDS, CATEGORY_FIELDS, CATEGORY_OPTION_COMBO_FIELDS, CATEGORY_OPTION_FIELDS, CATEGORY_OPTION_GROUP_FIELDS, CATEGORY_OPTION_GROUP_SET_FIELDS, config, DASHBOARD_FIELDS, DATA_ELEMENT_FIELDS, DATA_ELEMENT_GROUP_SET_FIELDS, DATA_SET_FIELDS, DATA_SET_PARAM, DATA_SET_VALIDATION_FIELDS, FIELDS_PARAM, httpClient, ID_FIELDS, INDICATOR_FIELDS, INDICATOR_GROUP_SET_FIELDS, INDICATOR_TYPE_FIELDS, ME_FIELDS, NAME_FIELDS, objectMapper, OPTION_SET_FIELDS, ORG_UNIT_FIELDS, ORG_UNIT_GROUP_SET_FIELDS, PROGRAM_FIELDS, PROGRAM_STAGE_DATA_ELEMENT_FIELDS, SKIP_SHARING_PARAM, TRACKED_ENTITY_ATTRIBUTE_FIELDS, TRACKED_ENTITY_TYPE_FIELDS, VALIDATION_RULE_FIELDS, VALIDATION_SIDE_FIELDS

Constructor Summary

Constructors

Constructor	Description
Dhis2(Dhis2Config config)

Method Summary

Modifier and Type	Method	Description
Response	addOrgUnitToOrgUnitGroup(String orgUnitGroup, String orgUnit)	Adds the program to the org unit.
Response	addOrgUnitToProgram(String program, String orgUnit)	Adds the program to the org unit.
DataValueSet	getAnalyticsDataValueSet(AnalyticsQuery query)	Retrieves a DataValueSet.
List<Category>	getCategories(Query query)	Retrieves a list of Category.
Category	getCategory(String id)	Retrieves an Category.
CategoryCombo	getCategoryCombo(String id)	Retrieves an CategoryCombo.
List<CategoryCombo>	getCategoryCombos(Query query)	Retrieves a list of CategoryCombo.
CategoryOption	getCategoryOption(String id)	Retrieves an CategoryOption.
CategoryOptionCombo	getCategoryOptionCombo(String id)	Retrieves an CategoryOptionCombo.
List<CategoryOptionCombo>	getCategoryOptionCombos(Query query)	Retrieves a list of CategoryOptionCombo.
CategoryOptionGroup	getCategoryOptionGroup(String id)	Retrieves an CategoryOptionGroup.
List<CategoryOptionGroup>	getCategoryOptionGroups(Query query)	Retrieves a list of CategoryOptionGroup.
CategoryOptionGroupSet	getCategoryOptionGroupSet(String id)	Retrieves an CategoryOptionGroupSet.
List<CategoryOptionGroupSet>	getCategoryOptionGroupSets(Query query)	Retrieves a list of CategoryOptionGroupSet.
List<CategoryOption>	getCategoryOptions(Query query)	Retrieves a list of CategoryOption.
List<CompleteDataSetRegistration>	getCompleteDataSetRegistrations(CompleteDataSetRegistrationQuery query)	Retrieves a list of CompleteDataSetRegistration.
Dashboard	getDashboard(String id)	Retrieves a Dashboard.
List<Dashboard>	getDashboards(Query query)	Retrieves a list of Dashboard.
DataElement	getDataElement(String id)	Retrieves an DataElement.
DataElementGroup	getDataElementGroup(String id)	Retrieves an DataElementGroup.
List<DataElementGroup>	getDataElementGroups(Query query)	Retrieves a list of DataElementGroup.
DataElementGroupSet	getDataElementGroupSet(String id)	Retrieves an DataElementGroupSet.
List<DataElementGroupSet>	getDataElementGroupSets(Query query)	Retrieves a list of DataElementGroupSet.
List<DataElement>	getDataElements(Query query)	Retrieves a list of DataElement.
DataSet	getDataSet(String id)	Retrieves an DataSet.
List<DataSet>	getDataSets(Query query)	Retrieves a list of DataSet.
Validation	getDataSetValidation(DataSetValidationQuery query)	Retrieves the validation results of a DataSet in a particular Period and OrgUnit.
List<Map<String,Object>>	getDatastoreEntries(String namespace, List<String> fields)	Retrieves a list of data store entries.
<T> T	getDataStoreEntry(String namespace, String key, Class<T> type)	Retrieves a data store entry.
EntryMetadata	getDataStoreEntryMetadata(String namespace, String key)	Retrieves metadata for a data store entry.
List<String>	getDataStoreKeys(String namespace)	Retrieves all data store keys for the given namespace.
List<String>	getDataStoreNamespaces()	Retrieves all data store namespaces.
String	getDataValueFile(DataValueQuery query)	Retrieves the content of a file resource from a DataValue.
DataValueSet	getDataValueSet(DataValueSetQuery query)	Retrieves a DataValueSet.
String	getDhis2Url()	Returns the URL of the DHIS 2 configuration.
Dimension	getDimension(String id)	Retrieves a Dimension.
List<Dimension>	getDimensions(Query query)	Retrieves a list of Dimension.
Event	getEvent(String id)	Retrieves an Event.
EventsResult	getEvents(EventsQuery query)	Retrieves an Events.
FileResource	getFileResource(String id)	Retrieves a FileResource.
List<OrgUnitLevel>	getFilledOrgUnitLevels()	Retrieves a list of "filled" OrgUnitLevel, meaning any gaps in the persisted levels will be inserted by generated levels.
Indicator	getIndicator(String id)	Retrieves an Indicator.
IndicatorGroup	getIndicatorGroup(String id)	Retrieves an IndicatorGroup.
List<IndicatorGroup>	getIndicatorGroups(Query query)	Retrieves a list of IndicatorGroup.
IndicatorGroupSet	getIndicatorGroupSet(String id)	Retrieves an IndicatorGroupSet.
List<IndicatorGroupSet>	getIndicatorGroupSets(Query query)	Retrieves a list of IndicatorGroupSet.
List<Indicator>	getIndicators(Query query)	Retrieves a list of Indicator.
IndicatorType	getIndicatorType(String id)	Retrieves an IndicatorType.
List<IndicatorType>	getIndicatorTypes(Query query)	Retrieves a list of IndicatorType.
List<JobNotification>	getJobNotifications(JobCategory category, String id)	Retrieves a list of JobNotification.
GeoMap	getMap(String id)	Retrieves a GeoMap.
List<GeoMap>	getMaps(Query query)	Retrieves a list of GeoMap.
Me	getMe()	Retrieves information about the current authenticated user.
OptionSet	getOptionSet(String id)	Retrieves an OptionSet.
List<OptionSet>	getOptionSets(Query query)	Retrieves a list of OptionSet.
OrgUnit	getOrgUnit(String id)	Retrieves an OrgUnit.
OrgUnitGroup	getOrgUnitGroup(String id)	Retrieves an OrgUnitGroup.
List<OrgUnitGroup>	getOrgUnitGroups(Query query)	Retrieves a list of OrgUnitGroup.
OrgUnitGroupSet	getOrgUnitGroupSet(String id)	Retrieves an OrgUnitGroupSet.
List<OrgUnitGroupSet>	getOrgUnitGroupSets(Query query)	Retrieves a list of OrgUnitGroupSet.
OrgUnitLevel	getOrgUnitLevel(String id)	Retrieves an OrgUnitLevel.
List<OrgUnitLevel>	getOrgUnitLevels(Query query)	Retrieves a list of OrgUnitLevel.
List<OrgUnit>	getOrgUnits(Query query)	Retrieves a list of OrgUnit.
List<OrgUnit>	getOrgUnitSubHierarchy(String id, Integer level, Query query)	Retrieves a list of OrgUnit which represents the sub-hierarchy of the given parent org unit.
List<PeriodType>	getPeriodTypes(Query query)	Retrieves a list of PeriodType.
Program	getProgram(String id)	Retrieves a Program.
ProgramIndicator	getProgramIndicator(String id)	Retrieves a ProgramIndicator.
List<ProgramIndicator>	getProgramIndicators(Query query)	Retrieves a list of ProgramIndicator.
List<Program>	getPrograms(Query query)	Retrieves a list of Program.
HttpStatus	getStatus()	Checks the status of the DHIS 2 instance.
SystemInfo	getSystemInfo()	Retrieves the SystemInfo.
SystemSettings	getSystemSettings()	Retrieves SystemSettings.
TableHook	getTableHook(String id)	Retrieves an TableHook.
List<TableHook>	getTableHooks(Query query)	Retrieves a list of TableHook.
TrackedEntityType	getTrackedEntityType(String id)	Retrieves a TrackedEntityType.
List<TrackedEntityType>	getTrackedEntityTypes(Query query)	Retrieves a list of TrackedEntityType.
List<String>	getUserAuthorization()	Retrieves the list of authorities granted to the authenticated user.
List<ValidationRule>	getValidationRules(String dataSet)	Retrieves a list of ValidationRule.
Visualization	getVisualization(String id)	Retrieves a Visualization.
List<Visualization>	getVisualizations(Query query)	Retrieves a list of Visualization.
boolean	isCategory(String id)	Indicates whether a Category exists.
boolean	isDataElement(String id)	Indicates whether a DataElement exists.
boolean	isOrgUnit(String id)	Indicates whether an OrgUnit exists.
boolean	isProgram(String id)	Indicates whether a Program exists.
Response	mergeOrgUnits(OrgUnitMergeRequest request)	Performs an org unit merge operation.
boolean	objectExists(String path)	Indicates whether an object exists at the given URL path using HTTP HEAD.
ObjectResponse	removeCategory(String id)	Removes a Category.
ObjectResponse	removeCategoryCombo(String id)	Removes a CategoryCombo.
ObjectResponse	removeCategoryOption(String id)	Removes a CategoryOption.
ObjectResponse	removeCategoryOptionGroup(String id)	Removes a CategoryOptionGroup.
ObjectResponse	removeCategoryOptionGroupSet(String id)	Removes a CategoryOptionGroupSet.
ObjectResponse	removeDashboard(String id)	Removes a Dashboard.
ObjectResponse	removeDataElement(String id)	Removes a DataElement.
ObjectResponse	removeDataElementGroup(String id)	Removes a DataElementGroup.
ObjectResponse	removeDataElementGroupSet(String id)	Removes a DataElementGroupSet.
ObjectResponse	removeDataSet(String id)	Removes a DataSet.
Response	removeDataStoreEntry(String namespace, String key)	Removes a data store entry.
Response	removeDataStoreNamespace(String namespace)	Removes a namespace including all entries.
EventResponse	removeEvent(Event event)	Removes an Event.
EventResponse	removeEvents(Events events)	Removes an Events.
ObjectResponse	removeIndicator(String id)	Removes an Indicator.
ObjectResponse	removeIndicatorGroup(String id)	Removes an IndicatorGroup.
ObjectResponse	removeIndicatorGroupSet(String id)	Removes an IndicatorGroupSet.
ObjectResponse	removeIndicatorType(String id)	Removes an IndicatorType.
ObjectResponse	removeMap(String id)	Removes a GeoMap.
ObjectResponse	removeOptionSet(String id)	Removes an OptionSet.
ObjectResponse	removeOrgUnit(String id)	Removes a OrgUnit.
ObjectResponse	removeOrgUnitGroup(String id)	Removes a OrgUnitGroup.
ObjectResponse	removeOrgUnitGroupSet(String id)	Removes a OrgUnitGroupSet.
ObjectResponse	removeProgram(String id)	Removes a Program.
ObjectResponse	removeProgramIndicator(String id)	Removes a ProgramIndicator.
ObjectResponse	removeTableHook(String id)	Removes a TableHook.
ObjectResponse	removeVisualization(String id)	Removes a Visualization.
ObjectsResponse	saveCategories(List<Category> categories)	Saves or updates the list of Category.
ObjectResponse	saveCategory(Category category)	Saves a Category.
ObjectResponse	saveCategoryCombo(CategoryCombo categoryCombo)	Saves a CategoryCombo.
ObjectResponse	saveCategoryOption(CategoryOption categoryOption)	Saves a CategoryOption.
ObjectsResponse	saveCategoryOptions(List<CategoryOption> categoryOptions)	Saves or updates the list of CategoryOption.
CompleteDataSetRegistrationResponse	saveCompleteDataSetRegistrations(File file, CompleteDataSetRegistrationImportOptions options)	Saves a complete data set registration payload in JSON format represented by the given file.
CompleteDataSetRegistrationResponse	saveCompleteDataSetRegistrations(InputStream inputStream, CompleteDataSetRegistrationImportOptions options)	Saves a complete data set registration payload in JSON format represented by the given input stream.
CompleteDataSetRegistrationResponse	saveCompleteDataSetRegistrations(List<CompleteDataSetRegistration> completeDataSetRegistrations, CompleteDataSetRegistrationImportOptions options)	Saves or updates the list of CompleteDataSetRegistration.
ObjectResponse	saveDataElement(DataElement dataElement)	Saves a DataElement.
ObjectResponse	saveDataElementGroup(DataElementGroup dataElementGroup)	Saves a DataElement.
ObjectsResponse	saveDataElementGroups(List<DataElementGroup> dataElementGroups)	Saves or updates the list of DataElementGroup.
ObjectsResponse	saveDataElements(List<DataElement> dataElements)	Saves or updates the list of DataElement.
<T> Response	saveDataStoreEntry(String namespace, String key, T object)	Saves a data store entry.
DataValueSetResponse	saveDataValueSet(File file, DataValueSetImportOptions options)	Saves a data value set payload in JSON format represented by the given file.
DataValueSetResponse	saveDataValueSet(InputStream inputStream, DataValueSetImportOptions options)	Saves a data value set payload in JSON format represented by the given input stream.
DataValueSetResponse	saveDataValueSet(DataValueSet dataValueSet, DataValueSetImportOptions options)	Saves a DataValueSet.
EventResponse	saveEvents(Events events)	Saves an Events.
ObjectResponse	saveOrgUnit(OrgUnit orgUnit)	Saves a OrgUnit.
ObjectResponse	saveOrgUnitGroup(OrgUnitGroup orgUnitGroup)	Saves a OrgUnitGroup.
ObjectsResponse	saveOrgUnitGroups(List<OrgUnitGroup> orgUnitGroups)	Saves or updates the list of OrgUnitGroup.
ObjectResponse	saveOrgUnitGroupSet(OrgUnitGroupSet orgUnitGroupSet)	Saves a OrgUnitGroupSet.
ObjectsResponse	saveOrgUnitGroupSets(List<OrgUnitGroupSet> orgUnitGroupSets)	Saves or updates the list of OrgUnitGroupSet.
ObjectsResponse	saveOrgUnits(List<OrgUnit> orgUnits)	Saves or updates the list of OrgUnit.
ObjectResponse	saveTableHook(TableHook tableHook)	Saves a TableHook.
ObjectsResponse	saveTableHooks(List<TableHook> tableHooks)	Saves or updates the list of TableHook.
Response	splitOrgUnit(OrgUnitSplitRequest request)	Performs an org unit split operation.
ObjectResponse	updateCategory(Category category)	Updates a Category.
ObjectResponse	updateCategoryOption(CategoryOption categoryOption)	Updates a CategoryOption.
ObjectResponse	updateDataElement(DataElement dataElement)	Updates a DataElement.
ObjectResponse	updateDataElementGroup(DataElementGroup dataElementGroup)	Updates a DataElementGroup.
<T> Response	updateDataStoreEntry(String namespace, String key, T object)	Updates a data store entry.
ObjectResponse	updateOrgUnit(OrgUnit orgUnit)	Updates a OrgUnit.
ObjectResponse	updateOrgUnitGroup(OrgUnitGroup orgUnitGroup)	Updates a OrgUnitGroup.
ObjectResponse	updateOrgUnitGroupSet(OrgUnitGroupSet orgUnitGroupSet)	Updates a OrgUnitGroupSet.
ObjectResponse	updateTableHook(TableHook tableHook)	Updates a TableHook.
static Dhis2	withAccessTokenAuth(String url, String accessToken)	Creates a Dhis2 instance configured for access token (PAT) authentication.
static Dhis2	withBasicAuth(String url, String username, String password)	Creates a Dhis2 instance configured for basic authentication.
static Dhis2	withCookieAuth(String url, String sessionId)	Creates a Dhis2 instance configured for cookie authentication.
void	writeAnalyticsDataValueSet(AnalyticsQuery query, File file)	Retrieves a DataValueSet and writes it to the given file.

Methods inherited from class org.hisp.dhis.BaseDhis2

addToCollection, executeJsonPostPutRequest, executeRequest, getAnalyticsQuery, getAnalyticsResponse, getCompleteDataSetRegistrationQuery, getDataSetValidationQuery, getDataSetValidationResponse, getDataValueFileResponse, getDataValueQuery, getDataValueSetImportQuery, getDataValueSetQuery, getDataValueSetResponse, getEventsQuery, getEventsResponse, getJsonHttpResponse, getObject, getObject, getObject, getObjectFromUrl, getObjectQuery, getPostRequest, newDhis2ClientException, objectExists, readValue, removeMetadataObject, removeObject, saveCompleteDataSetRegistrations, saveMetadataObject, saveMetadataObjects, saveObject, saveObject, toJsonString, toNameValuePairs, updateMetadataObject, updateObject, withAuth, writeToFile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SUPER_AUTH

public static final String SUPER_AUTH

Authority which provides superuser authorization in DHIS 2.

See Also:

• Constant Field Values

Constructor Details

Dhis2

public Dhis2(Dhis2Config config)

Method Details

withBasicAuth

public static Dhis2 withBasicAuth(String url,
 String username,
 String password)

Creates a Dhis2 instance configured for basic authentication.

Parameters:

url - the URL to the DHIS 2 instance, do not include the /api part or a trailing /.

username - the DHIS 2 account username.

password - the DHIS 2 account password.

Returns:

a Dhis2 instance.

withAccessTokenAuth

public static Dhis2 withAccessTokenAuth(String url,
 String accessToken)

Creates a Dhis2 instance configured for access token (PAT) authentication.

Parameters:

url - the URL to the DHIS 2 instance, do not include the /api part or a trailing /.

accessToken - the access token (PAT).

Returns:

a Dhis2 instance.

withCookieAuth

public static Dhis2 withCookieAuth(String url,
 String sessionId)

Creates a Dhis2 instance configured for cookie authentication.

Parameters:

url - the URL to the DHIS 2 instance, do not include the /api part or a trailing /.

sessionId - the session identifier.

Returns:

a Dhis2 instance.

getStatus

public HttpStatus getStatus()

Checks the status of the DHIS 2 instance. Returns various status codes describing the status:

• HttpStatus.OK if instance is available and authentication isf successful.
• HttpStatus.UNAUTHORIZED if the username and password combination is not valid.
• HttpStatus.NOT_FOUND if the URL is not pointing to a DHIS 2 instance or the DHIS 2 instance is not available.

Returns:

the HTTP status code of the response.

getDhis2Url

public String getDhis2Url()

Returns the URL of the DHIS 2 configuration.

Returns:

the URL of the DHIS 2 configuration.

objectExists

public boolean objectExists(String path)

Indicates whether an object exists at the given URL path using HTTP HEAD.

Parameters:

path - the URL path relative to the API end point.

Returns:

true if the object exists.

getSystemInfo

public SystemInfo getSystemInfo()

Retrieves the SystemInfo.

Returns:

the SystemInfo.

getUserAuthorization

public List<String> getUserAuthorization()

Retrieves the list of authorities granted to the authenticated user.

Returns:

a list of authorities.

getMe

public Me getMe()

Retrieves information about the current authenticated user.

Returns:

the current authenticated user.

saveDataStoreEntry

public <T> Response saveDataStoreEntry(String namespace,
 String key,
 T object)

Saves a data store entry.

Type Parameters:

T - the object type.

Parameters:

namespace - the namespace.

key - the key.

object - the object.

Returns:

Response holding information about the operation.

updateDataStoreEntry

public <T> Response updateDataStoreEntry(String namespace,
 String key,
 T object)

Updates a data store entry.

Type Parameters:

T - the object type.

Parameters:

namespace - the namespace.

key - the key.

object - the object.

Returns:

Response holding information about the operation.

getDataStoreNamespaces

public List<String> getDataStoreNamespaces()

Retrieves all data store namespaces.

Returns:

the list of namespaces.

getDataStoreKeys

public List<String> getDataStoreKeys(String namespace)

Retrieves all data store keys for the given namespace.

Parameters:

namespace - the namespace.

Returns:

the list of keys.

getDataStoreEntry

public <T> T getDataStoreEntry(String namespace,
 String key,
 Class<T> type)

Retrieves a data store entry.

Type Parameters:

T - the object type.

Parameters:

namespace - the namespace.

key - the key.

type - the class type of the object to retrieve.

Returns:

the object associated with the given namespace and key.

getDatastoreEntries

public List<Map<String,Object>> getDatastoreEntries(String namespace,
 List<String> fields)

Retrieves a list of data store entries.

Parameters:

namespace - the namespace.

fields - the list of fields, must not be empty.

Returns:

a list of data store entries.

getDataStoreEntryMetadata

public EntryMetadata getDataStoreEntryMetadata(String namespace,
 String key)

Retrieves metadata for a data store entry.

Parameters:

namespace - the namespace.

key - the key.

Returns:

the EntryMetadata.

removeDataStoreEntry

public Response removeDataStoreEntry(String namespace,
 String key)

Removes a data store entry.

Parameters:

namespace - the namespace.

key - the key.

Returns:

Response holding information about the operation.

removeDataStoreNamespace

public Response removeDataStoreNamespace(String namespace)

Removes a namespace including all entries.

Parameters:

namespace - the namespace.

Returns:

Response holding information about the operation.

saveOrgUnit

public ObjectResponse saveOrgUnit(OrgUnit orgUnit)

Saves a OrgUnit.

Parameters:

orgUnit - the object to save.

Returns:

ObjectResponse holding information about the operation.

saveOrgUnits

public ObjectsResponse saveOrgUnits(List<OrgUnit> orgUnits)

Saves or updates the list of OrgUnit.

Parameters:

orgUnits - the list of OrgUnit.

Returns:

ObjectsResponse holding information about the operation.

updateOrgUnit

public ObjectResponse updateOrgUnit(OrgUnit orgUnit)

Updates a OrgUnit.

Parameters:

orgUnit - the object to update.

Returns:

ObjectResponse holding information about the operation.

removeOrgUnit

public ObjectResponse removeOrgUnit(String id)

Removes a OrgUnit.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getOrgUnit

public OrgUnit getOrgUnit(String id)

Retrieves an OrgUnit.

Parameters:

id - the object identifier.

Returns:

the OrgUnit.

Throws:

Dhis2ClientException - if the object does not exist.

isOrgUnit

public boolean isOrgUnit(String id)

Indicates whether an OrgUnit exists.

Parameters:

id - the object identifier.

Returns:

true if the object exists.

getOrgUnitSubHierarchy

public List<OrgUnit> getOrgUnitSubHierarchy(String id,
 Integer level,
 Query query)

Retrieves a list of OrgUnit which represents the sub-hierarchy of the given parent org unit.

Parameters:

id - the identifier of the parent org unit.

level - the org unit level, relative to the level of the parent org unit, where 1 is the level immediately below.

query - the Query.

Returns:

list of OrgUnit.

getOrgUnits

public List<OrgUnit> getOrgUnits(Query query)

Retrieves a list of OrgUnit.

Parameters:

query - the Query.

Returns:

list of OrgUnit.

splitOrgUnit

public Response splitOrgUnit(OrgUnitSplitRequest request)

Performs an org unit split operation.

Parameters:

request - the OrgUnitSplitRequest.

Returns:

the Response holding information about the operation.

mergeOrgUnits

public Response mergeOrgUnits(OrgUnitMergeRequest request)

Performs an org unit merge operation.

Parameters:

request - the request.

Returns:

the Response holding information about the operation.

saveOrgUnitGroup

public ObjectResponse saveOrgUnitGroup(OrgUnitGroup orgUnitGroup)

Saves a OrgUnitGroup.

Parameters:

orgUnitGroup - the object to save.

Returns:

ObjectResponse holding information about the operation.

saveOrgUnitGroups

public ObjectsResponse saveOrgUnitGroups(List<OrgUnitGroup> orgUnitGroups)

Saves or updates the list of OrgUnitGroup.

Parameters:

orgUnitGroups - the list of OrgUnitGroup.

Returns:

ObjectsResponse holding information about the operation.

updateOrgUnitGroup

public ObjectResponse updateOrgUnitGroup(OrgUnitGroup orgUnitGroup)

Updates a OrgUnitGroup.

Parameters:

orgUnitGroup - the object to update.

Returns:

ObjectResponse holding information about the operation.

removeOrgUnitGroup

public ObjectResponse removeOrgUnitGroup(String id)

Removes a OrgUnitGroup.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getOrgUnitGroup

public OrgUnitGroup getOrgUnitGroup(String id)

Retrieves an OrgUnitGroup.

Parameters:

id - the object identifier.

Returns:

the OrgUnitGroup.

Throws:

Dhis2ClientException - if the object does not exist.

getOrgUnitGroups

public List<OrgUnitGroup> getOrgUnitGroups(Query query)

Retrieves a list of OrgUnitGroup.

Parameters:

query - the Query.

Returns:

list of OrgUnitGroup.

addOrgUnitToOrgUnitGroup

public Response addOrgUnitToOrgUnitGroup(String orgUnitGroup,
 String orgUnit)

Adds the program to the org unit.

Parameters:

orgUnitGroup - the org unit group identifier.

orgUnit - the org unit identifier.

Returns:

a Response.

saveOrgUnitGroupSet

public ObjectResponse saveOrgUnitGroupSet(OrgUnitGroupSet orgUnitGroupSet)

Saves a OrgUnitGroupSet.

Parameters:

orgUnitGroupSet - the object to save.

Returns:

ObjectResponse holding information about the operation.

saveOrgUnitGroupSets

public ObjectsResponse saveOrgUnitGroupSets(List<OrgUnitGroupSet> orgUnitGroupSets)

Saves or updates the list of OrgUnitGroupSet.

Parameters:

orgUnitGroupSets - the list of OrgUnitGroupSet.

Returns:

ObjectsResponse holding information about the operation.

updateOrgUnitGroupSet

public ObjectResponse updateOrgUnitGroupSet(OrgUnitGroupSet orgUnitGroupSet)

Updates a OrgUnitGroupSet.

Parameters:

orgUnitGroupSet - the object to update.

Returns:

ObjectResponse holding information about the operation.

removeOrgUnitGroupSet

public ObjectResponse removeOrgUnitGroupSet(String id)

Removes a OrgUnitGroupSet.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getOrgUnitGroupSet

public OrgUnitGroupSet getOrgUnitGroupSet(String id)

Retrieves an OrgUnitGroupSet.

Parameters:

id - the object identifier.

Returns:

the OrgUnitGroupSet.

Throws:

Dhis2ClientException - if the object does not exist.

getOrgUnitGroupSets

public List<OrgUnitGroupSet> getOrgUnitGroupSets(Query query)

Retrieves a list of OrgUnitGroupSet.

Parameters:

query - the Query.

Returns:

list of OrgUnitGroupSet.

getOrgUnitLevel

public OrgUnitLevel getOrgUnitLevel(String id)

Retrieves an OrgUnitLevel.

Parameters:

id - the object identifier.

Returns:

the OrgUnitLevel.

Throws:

Dhis2ClientException - if the object does not exist.

getOrgUnitLevels

public List<OrgUnitLevel> getOrgUnitLevels(Query query)

Retrieves a list of OrgUnitLevel.

Parameters:

query - the Query.

Returns:

list of OrgUnitLevel.

getFilledOrgUnitLevels

public List<OrgUnitLevel> getFilledOrgUnitLevels()

Retrieves a list of "filled" OrgUnitLevel, meaning any gaps in the persisted levels will be inserted by generated levels.

Returns:

list of OrgUnitLevel.

saveCategoryOption

public ObjectResponse saveCategoryOption(CategoryOption categoryOption)

Saves a CategoryOption.

Parameters:

categoryOption - the object to save.

Returns:

ObjectResponse holding information about the operation.

saveCategoryOptions

public ObjectsResponse saveCategoryOptions(List<CategoryOption> categoryOptions)

Saves or updates the list of CategoryOption.

Parameters:

categoryOptions - the list of CategoryOption.

Returns:

ObjectsResponse holding information about the operation.

updateCategoryOption

public ObjectResponse updateCategoryOption(CategoryOption categoryOption)

Updates a CategoryOption.

Parameters:

categoryOption - the object to update.

Returns:

ObjectResponse holding information about the operation.

removeCategoryOption

public ObjectResponse removeCategoryOption(String id)

Removes a CategoryOption.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getCategoryOption

public CategoryOption getCategoryOption(String id)

Retrieves an CategoryOption.

Parameters:

id - the object identifier.

Returns:

the CategoryOption.

Throws:

Dhis2ClientException - if the object does not exist.

getCategoryOptions

public List<CategoryOption> getCategoryOptions(Query query)

Retrieves a list of CategoryOption.

Parameters:

query - the Query.

Returns:

list of CategoryOption.

saveCategory

public ObjectResponse saveCategory(Category category)

Saves a Category.

Parameters:

category - the object to save.

Returns:

ObjectResponse holding information about the operation.

saveCategories

public ObjectsResponse saveCategories(List<Category> categories)

Saves or updates the list of Category.

Parameters:

categories - the list of Category.

Returns:

ObjectsResponse holding information about the operation.

updateCategory

public ObjectResponse updateCategory(Category category)

Updates a Category.

Parameters:

category - the object to update.

Returns:

ObjectResponse holding information about the operation.

removeCategory

public ObjectResponse removeCategory(String id)

Removes a Category.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getCategory

public Category getCategory(String id)

Retrieves an Category.

Parameters:

id - the object identifier.

Returns:

the Category.

Throws:

Dhis2ClientException - if the object does not exist.

isCategory

public boolean isCategory(String id)

Indicates whether a Category exists.

Parameters:

id - the object identifier.

Returns:

true if the object exists.

getCategories

public List<Category> getCategories(Query query)

Retrieves a list of Category.

Parameters:

query - the Query.

Returns:

list of Category.

saveCategoryCombo

public ObjectResponse saveCategoryCombo(CategoryCombo categoryCombo)

Saves a CategoryCombo.

Parameters:

categoryCombo - the object to save.

Returns:

ObjectResponse holding information about the operation.

removeCategoryCombo

public ObjectResponse removeCategoryCombo(String id)

Removes a CategoryCombo.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getCategoryCombo

public CategoryCombo getCategoryCombo(String id)

Retrieves an CategoryCombo.

Parameters:

id - the object identifier.

Returns:

the CategoryCombo.

Throws:

Dhis2ClientException - if the object does not exist.

getCategoryCombos

public List<CategoryCombo> getCategoryCombos(Query query)

Retrieves a list of CategoryCombo.

Parameters:

query - the Query.

Returns:

list of CategoryCombo.

getCategoryOptionCombo

public CategoryOptionCombo getCategoryOptionCombo(String id)

Retrieves an CategoryOptionCombo.

Parameters:

id - the object identifier.

Returns:

the CategoryOptionCombo.

Throws:

Dhis2ClientException - if the object does not exist.

getCategoryOptionCombos

public List<CategoryOptionCombo> getCategoryOptionCombos(Query query)

Retrieves a list of CategoryOptionCombo.

Parameters:

query - the Query.

Returns:

list of CategoryOptionCombo.

saveDataElement

public ObjectResponse saveDataElement(DataElement dataElement)

Saves a DataElement.

Parameters:

dataElement - the object to save.

Returns:

ObjectResponse holding information about the operation.

saveDataElements

public ObjectsResponse saveDataElements(List<DataElement> dataElements)

Saves or updates the list of DataElement.

Parameters:

dataElements - the list of DataElement.

Returns:

ObjectsResponse holding information about the operation.

updateDataElement

public ObjectResponse updateDataElement(DataElement dataElement)

Updates a DataElement.

Parameters:

dataElement - the object to update.

Returns:

ObjectResponse holding information about the operation.

removeDataElement

public ObjectResponse removeDataElement(String id)

Removes a DataElement.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getDataElement

public DataElement getDataElement(String id)

Retrieves an DataElement.

Parameters:

id - the object identifier.

Returns:

the DataElement.

Throws:

Dhis2ClientException - if the object does not exist.

isDataElement

public boolean isDataElement(String id)

Indicates whether a DataElement exists.

Parameters:

id - the object identifier.

Returns:

true if the object exists.

getDataElements

public List<DataElement> getDataElements(Query query)

Retrieves a list of DataElement.

Parameters:

query - the Query.

Returns:

list of DataElement.

saveDataElementGroup

public ObjectResponse saveDataElementGroup(DataElementGroup dataElementGroup)

Saves a DataElement.

Parameters:

dataElementGroup - the object to save.

Returns:

ObjectResponse holding information about the operation.

saveDataElementGroups

public ObjectsResponse saveDataElementGroups(List<DataElementGroup> dataElementGroups)

Saves or updates the list of DataElementGroup.

Parameters:

dataElementGroups - the list of DataElementGroup.

Returns:

ObjectsResponse holding information about the operation.

updateDataElementGroup

public ObjectResponse updateDataElementGroup(DataElementGroup dataElementGroup)

Updates a DataElementGroup.

Parameters:

dataElementGroup - the object to update.

Returns:

ObjectResponse holding information about the operation.

removeDataElementGroup

public ObjectResponse removeDataElementGroup(String id)

Removes a DataElementGroup.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getDataElementGroup

public DataElementGroup getDataElementGroup(String id)

Retrieves an DataElementGroup.

Parameters:

id - the object identifier.

Returns:

the DataElementGroup.

Throws:

Dhis2ClientException - if the object does not exist.

getDataElementGroups

public List<DataElementGroup> getDataElementGroups(Query query)

Retrieves a list of DataElementGroup.

Parameters:

query - the Query.

Returns:

list of DataElementGroup.

removeDataElementGroupSet

public ObjectResponse removeDataElementGroupSet(String id)

Removes a DataElementGroupSet.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getDataElementGroupSet

public DataElementGroupSet getDataElementGroupSet(String id)

Retrieves an DataElementGroupSet.

Parameters:

id - the object identifier.

Returns:

the DataElementGroupSet.

getDataElementGroupSets

public List<DataElementGroupSet> getDataElementGroupSets(Query query)

Retrieves a list of DataElementGroupSet.

Parameters:

query - the Query.

Returns:

list of DataElementGroupSet.

removeIndicator

public ObjectResponse removeIndicator(String id)

Removes an Indicator.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getIndicator

public Indicator getIndicator(String id)

Retrieves an Indicator.

Parameters:

id - the object identifier.

Returns:

the Indicator.

getIndicators

public List<Indicator> getIndicators(Query query)

Retrieves a list of Indicator.

Parameters:

query - the Query.

Returns:

list of Indicator.

removeIndicatorGroup

public ObjectResponse removeIndicatorGroup(String id)

Removes an IndicatorGroup.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getIndicatorGroup

public IndicatorGroup getIndicatorGroup(String id)

Retrieves an IndicatorGroup.

Parameters:

id - the object identifier.

Returns:

the IndicatorGroup.

Throws:

Dhis2ClientException - if the object does not exist.

getIndicatorGroups

public List<IndicatorGroup> getIndicatorGroups(Query query)

Retrieves a list of IndicatorGroup.

Parameters:

query - the Query.

Returns:

list of IndicatorGroup.

removeIndicatorGroupSet

public ObjectResponse removeIndicatorGroupSet(String id)

Removes an IndicatorGroupSet.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getIndicatorGroupSet

public IndicatorGroupSet getIndicatorGroupSet(String id)

Retrieves an IndicatorGroupSet.

Parameters:

id - the object identifier.

Returns:

the IndicatorGroupSet.

getIndicatorGroupSets

public List<IndicatorGroupSet> getIndicatorGroupSets(Query query)

Retrieves a list of IndicatorGroupSet.

Parameters:

query - the Query.

Returns:

list of IndicatorGroupSet.

removeIndicatorType

public ObjectResponse removeIndicatorType(String id)

Removes an IndicatorType.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getIndicatorType

public IndicatorType getIndicatorType(String id)

Retrieves an IndicatorType.

Parameters:

id - the object identifier.

Returns:

the IndicatorType.

getIndicatorTypes

public List<IndicatorType> getIndicatorTypes(Query query)

Retrieves a list of IndicatorType.

Parameters:

query - the Query.

Returns:

list of IndicatorType.

removeDataSet

public ObjectResponse removeDataSet(String id)

Removes a DataSet.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getDataSet

public DataSet getDataSet(String id)

Retrieves an DataSet.

Parameters:

id - the object identifier.

Returns:

the DataSet.

getDataSets

public List<DataSet> getDataSets(Query query)

Retrieves a list of DataSet.

Parameters:

query - the Query.

Returns:

list of DataSet.

getCompleteDataSetRegistrations

public List<CompleteDataSetRegistration> getCompleteDataSetRegistrations(CompleteDataSetRegistrationQuery query)

Retrieves a list of CompleteDataSetRegistration.

Parameters:

query - the Query.

Returns:

list of CompleteDataSetRegistration.

saveCompleteDataSetRegistrations

public CompleteDataSetRegistrationResponse saveCompleteDataSetRegistrations(List<CompleteDataSetRegistration> completeDataSetRegistrations,
 CompleteDataSetRegistrationImportOptions options)

Saves or updates the list of CompleteDataSetRegistration.

Parameters:

completeDataSetRegistrations - the list of CompleteDataSetRegistration.

options - import options CompleteDataSetRegistrationImportOptions.

Returns:

CompleteDataSetRegistrationResponse holding information about the operation.

saveCompleteDataSetRegistrations

public CompleteDataSetRegistrationResponse saveCompleteDataSetRegistrations(File file,
 CompleteDataSetRegistrationImportOptions options)

Saves a complete data set registration payload in JSON format represented by the given file.

Parameters:

file - the file representing the complete data set registration JSON payload.

options - the CompleteDataSetRegistrationImportOptions.

Returns:

CompleteDataSetRegistrationResponse holding information about the operation.

saveCompleteDataSetRegistrations

public CompleteDataSetRegistrationResponse saveCompleteDataSetRegistrations(InputStream inputStream,
 CompleteDataSetRegistrationImportOptions options)

Saves a complete data set registration payload in JSON format represented by the given input stream.

Parameters:

inputStream - the input stream representing the complete data set registration JSON payload.

options - the DataValueSetImportOptions.

Returns:

CompleteDataSetRegistrationResponse holding information about the operation.

removeProgram

public ObjectResponse removeProgram(String id)

Removes a Program.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getProgram

public Program getProgram(String id)

Retrieves a Program.

Parameters:

id - the object identifier.

Returns:

the Program.

Throws:

Dhis2ClientException - if the object does not exist.

isProgram

public boolean isProgram(String id)

Indicates whether a Program exists.

Parameters:

id - the object identifier.

Returns:

true if the object exists.

getPrograms

public List<Program> getPrograms(Query query)

Retrieves a list of Program.

Parameters:

query - the Query.

Returns:

list of Program.

addOrgUnitToProgram

public Response addOrgUnitToProgram(String program,
 String orgUnit)

Adds the program to the org unit.

Parameters:

program - the program identifier.

orgUnit - the org unit identifier.

Returns:

a Response.

removeProgramIndicator

public ObjectResponse removeProgramIndicator(String id)

Removes a ProgramIndicator.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getProgramIndicator

public ProgramIndicator getProgramIndicator(String id)

Retrieves a ProgramIndicator.

Parameters:

id - the object identifier.

Returns:

the ProgramIndicator.

getProgramIndicators

public List<ProgramIndicator> getProgramIndicators(Query query)

Retrieves a list of ProgramIndicator.

Parameters:

query - the Query.

Returns:

list of ProgramIndicator.

getTrackedEntityType

public TrackedEntityType getTrackedEntityType(String id)

Retrieves a TrackedEntityType.

Parameters:

id - the object identifier.

Returns:

the TrackedEntityType.

getTrackedEntityTypes

public List<TrackedEntityType> getTrackedEntityTypes(Query query)

Retrieves a list of TrackedEntityType.

Parameters:

query - the Query.

Returns:

list of TrackedEntityType.

removeCategoryOptionGroup

public ObjectResponse removeCategoryOptionGroup(String id)

Removes a CategoryOptionGroup.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getCategoryOptionGroup

public CategoryOptionGroup getCategoryOptionGroup(String id)

Retrieves an CategoryOptionGroup.

Parameters:

id - the object identifier.

Returns:

the CategoryOptionGroup.

Throws:

Dhis2ClientException - if the object does not exist.

getCategoryOptionGroups

public List<CategoryOptionGroup> getCategoryOptionGroups(Query query)

Retrieves a list of CategoryOptionGroup.

Parameters:

query - the Query.

Returns:

list of CategoryOptionGroup.

removeCategoryOptionGroupSet

public ObjectResponse removeCategoryOptionGroupSet(String id)

Removes a CategoryOptionGroupSet.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getCategoryOptionGroupSet

public CategoryOptionGroupSet getCategoryOptionGroupSet(String id)

Retrieves an CategoryOptionGroupSet.

Parameters:

id - the object identifier.

Returns:

the CategoryOptionGroupSet.

Throws:

Dhis2ClientException - if the object does not exist.

getCategoryOptionGroupSets

public List<CategoryOptionGroupSet> getCategoryOptionGroupSets(Query query)

Retrieves a list of CategoryOptionGroupSet.

Parameters:

query - the Query.

Returns:

list of CategoryOptionGroupSet.

removeOptionSet

public ObjectResponse removeOptionSet(String id)

Removes an OptionSet.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getOptionSet

public OptionSet getOptionSet(String id)

Retrieves an OptionSet.

Parameters:

id - the object identifier.

Returns:

the OptionSet.

Throws:

Dhis2ClientException - if the object does not exist.

getOptionSets

public List<OptionSet> getOptionSets(Query query)

Retrieves a list of OptionSet.

Parameters:

query - the Query.

Returns:

list of OptionSet.

saveTableHook

public ObjectResponse saveTableHook(TableHook tableHook)

Saves a TableHook.

Parameters:

tableHook - the object to save.

Returns:

ObjectResponse holding information about the operation.

saveTableHooks

public ObjectsResponse saveTableHooks(List<TableHook> tableHooks)

Saves or updates the list of TableHook.

Parameters:

tableHooks - the list of TableHook.

Returns:

ObjectsResponse holding information about the operation.

updateTableHook

public ObjectResponse updateTableHook(TableHook tableHook)

Updates a TableHook.

Parameters:

tableHook - the object to update.

Returns:

ObjectResponse holding information about the operation.

removeTableHook

public ObjectResponse removeTableHook(String id)

Removes a TableHook.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getTableHook

public TableHook getTableHook(String id)

Retrieves an TableHook.

Parameters:

id - the identifier of the table hook.

Returns:

the TableHook.

Throws:

Dhis2ClientException - if the object does not exist.

getTableHooks

public List<TableHook> getTableHooks(Query query)

Retrieves a list of TableHook.

Parameters:

query - the Query.

Returns:

list of TableHook.

removeVisualization

public ObjectResponse removeVisualization(String id)

Removes a Visualization.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getVisualization

public Visualization getVisualization(String id)

Retrieves a Visualization.

Parameters:

id - the object identifier.

Returns:

the Visualization.

Throws:

Dhis2ClientException - if the object does not exist.

getVisualizations

public List<Visualization> getVisualizations(Query query)

Retrieves a list of Visualization.

Parameters:

query - the Query.

Returns:

list of Visualization.

removeMap

public ObjectResponse removeMap(String id)

Removes a GeoMap.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getMap

public GeoMap getMap(String id)

Retrieves a GeoMap.

Parameters:

id - the object identifier.

Returns:

the GeoMap.

Throws:

Dhis2ClientException - if the object does not exist.

getMaps

public List<GeoMap> getMaps(Query query)

Retrieves a list of GeoMap.

Parameters:

query - the Query.

Returns:

list of GeoMap.

removeDashboard

public ObjectResponse removeDashboard(String id)

Removes a Dashboard.

Parameters:

id - the identifier of the object to remove.

Returns:

ObjectResponse holding information about the operation.

getDashboard

public Dashboard getDashboard(String id)

Retrieves a Dashboard.

Parameters:

id - the object identifier.

Returns:

the Dashboard.

Throws:

Dhis2ClientException - if the object does not exist.

getDashboards

public List<Dashboard> getDashboards(Query query)

Retrieves a list of Dashboard.

Parameters:

query - the Query.

Returns:

list of Dashboard.

getDimension

public Dimension getDimension(String id)

Retrieves a Dimension.

Parameters:

id - the identifier of the dimension.

Returns:

the Dimension.

getDimensions

public List<Dimension> getDimensions(Query query)

Retrieves a list of Dimension.

Parameters:

query - the Query.

Returns:

list of Dimension.

getPeriodTypes

public List<PeriodType> getPeriodTypes(Query query)

Retrieves a list of PeriodType.

Parameters:

query - the Query.

Returns:

list of PeriodType.

getSystemSettings

public SystemSettings getSystemSettings()

Retrieves SystemSettings.

Returns:

system settings.

saveDataValueSet

public DataValueSetResponse saveDataValueSet(DataValueSet dataValueSet,
 DataValueSetImportOptions options)

Saves a DataValueSet.

Parameters:

dataValueSet - the DataValueSet to save.

options - the DataValueSetImportOptions.

Returns:

DataValueSetResponse holding information about the operation.

saveDataValueSet

public DataValueSetResponse saveDataValueSet(File file,
 DataValueSetImportOptions options)

Saves a data value set payload in JSON format represented by the given file.

Parameters:

file - the file representing the data value set JSON payload.

options - the DataValueSetImportOptions.

Returns:

DataValueSetResponse holding information about the operation.

saveDataValueSet

public DataValueSetResponse saveDataValueSet(InputStream inputStream,
 DataValueSetImportOptions options)

Saves a data value set payload in JSON format represented by the given input stream.

Parameters:

inputStream - the input stream representing the data value set JSON payload.

options - the DataValueSetImportOptions.

Returns:

DataValueSetResponse holding information about the operation.

getDataValueSet

public DataValueSet getDataValueSet(DataValueSetQuery query)

Retrieves a DataValueSet.

Parameters:

query - the AnalyticsQuery.

Returns:

DataValueSet.

getDataValueFile

public String getDataValueFile(DataValueQuery query)

Retrieves the content of a file resource from a DataValue.

Parameters:

query - the DataValueQuery.

Returns:

the content of a file resource referenced in a DataValue.

getAnalyticsDataValueSet

public DataValueSet getAnalyticsDataValueSet(AnalyticsQuery query)

Retrieves a DataValueSet.

Parameters:

query - the AnalyticsQuery.

Returns:

DataValueSet.

writeAnalyticsDataValueSet

public void writeAnalyticsDataValueSet(AnalyticsQuery query,
 File file)

Retrieves a DataValueSet and writes it to the given file.

Parameters:

query - the AnalyticsQuery.

file - the File.

saveEvents

public EventResponse saveEvents(Events events)

Saves an Events. The operation is synchronous.

Requires DHIS 2 version 2.36 or later.

Parameters:

events - the Events.

Returns:

EventResponse holding information about the operation.

getEvent

public Event getEvent(String id)

Retrieves an Event.

Requires DHIS 2 version 2.36 or later.

Parameters:

id - the event identifier.

Returns:

the Event.

getEvents

public EventsResult getEvents(EventsQuery query)

Retrieves an Events.

Requires DHIS 2 version 2.36 or later.

Parameters:

query - the EventsQuery.

Returns:

the Events.

removeEvents

public EventResponse removeEvents(Events events)

Removes an Events. The operation is synchronous.

Requires DHIS 2 version 2.36 or later.

Parameters:

events - the Events.

Returns:

EventResponse holding information about the operation.

removeEvent

public EventResponse removeEvent(Event event)

Removes an Event.

Requires DHIS 2 version 2.36 or later.

Parameters:

event - the Event.

Returns:

EventResponse holding information about the operation.

getJobNotifications

public List<JobNotification> getJobNotifications(JobCategory category,
 String id)

Retrieves a list of JobNotification.

Parameters:

category - the JobCategory.

id - the job identifier.

Returns:

list of JobNotification.

getFileResource

public FileResource getFileResource(String id)

Retrieves a FileResource.

Parameters:

id - the object identifier.

Returns:

the FileResource.

Throws:

Dhis2ClientException - if the object does not exist.

getDataSetValidation

public Validation getDataSetValidation(DataSetValidationQuery query)

Retrieves the validation results of a DataSet in a particular Period and OrgUnit.

Parameters:

query - the DataSetValidationQuery.

Returns:

the validation results of the DataSet in the specified Period and OrgUnit.

getValidationRules

public List<ValidationRule> getValidationRules(String dataSet)

Retrieves a list of ValidationRule.

Parameters:

dataSet - the object identifier of the Data Set where the validations apply.

Returns:

list of ValidationRule.