Dhis2 (DHIS 2 API client for Java and Spring 1.1.2 API)

java.lang.Object
- org.hisp.dhis.Dhis2

```
public class Dhis2
extends Object
```
DHIS 2 API client for HTTP requests and responses. Request and response bodies are in JSON format.

Author:

Lars Helge Overland

Constructor Summary

Constructors
Constructor and Description

Dhis2(Dhis2Config dhis2Config)

Dhis2(Dhis2Config dhis2Config, org.springframework.web.client.RestTemplate restTemplate)

Constructors
Constructor and Description
`Dhis2(Dhis2Config dhis2Config)`
`Dhis2(Dhis2Config dhis2Config, org.springframework.web.client.RestTemplate restTemplate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`.
`CategoryOptionGroupSet`	`getCategoryOptionGroupSet(String id)` Retrieves an `CategoryOptionGroupSet`.
`List<CategoryOptionGroupSet>`	`getCategoryOptionGroupSets(Query query)` Retrieves a list of `CategoryOptionGroupSet`.
`DataElement`	`getDataElement(String id)` Retrieves an `DataElement`.
`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`.
`Dimension`	`getDimension(String id)` Retrieves a `Dimension`.
`List<Dimension>`	`getDimensions(Query query)` Retrieves a list of `Dimension`.
`List<JobNotification>`	`getJobNotifications(JobCategory category, String id)` Retrieves a list of `JobNotification`.
`<T> T`	`getObject(String path, Class<T> klass)` Retrieves an object using HTTP GET.
`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 `OrgUnitGroupSet`.
`List<OrgUnit>`	`getOrgUnits(Query query)` Retrieves a list of `OrgUnit`.
`List<PeriodType>`	`getPeriodTypes(Query query)` Retrieves a list of `PeriodType`.
`Program`	`getProgram(String id)` Retrieves a `Program`.
`List<Program>`	`getPrograms(Query query)` Retrieves a list of `Program`.
`org.springframework.http.HttpStatus`	`getStatus()` Checks the status of the DHIS 2 instance.
`TableHook`	`getTableHook(String id)` Retrieves an `TableHook`.
`List<TableHook>`	`getTableHooks(Query query)` Retrieves a list of `TableHook`.
`boolean`	`objectExists(String path)` Indicates whether an object exists at the given URL path using HTTP HEAD.
`DataValueSetResponseMessage`	`saveDataValueSet(DataValueSet dataValueSet)` Saves a `DataValueSet`.
`<T> ResponseMessage`	`saveMetadataObject(String path, T object)` Saves an object using HTTP POST.
`ResponseMessage`	`saveOrgUnit(OrgUnit orgUnit)` Saves a `OrgUnit`.
`ResponseMessage`	`saveOrgUnitGroup(OrgUnitGroup orgUnitGroup)` Saves a `OrgUnitGroup`.
`ResponseMessage`	`saveOrgUnitGroupSet(OrgUnitGroupSet orgUnitGroupSet)` Saves a `OrgUnitGroupSet`.
`ResponseMessage`	`saveTableHook(TableHook tableHook)` Saves a `TableHook`.
`<T> ResponseMessage`	`updateObject(String path, T object)` Updates an object using HTTP PUT.
`ResponseMessage`	`updateOrgUnit(OrgUnit orgUnit)` Updates a `OrgUnit`.
`ResponseMessage`	`updateOrgUnitGroup(OrgUnitGroup orgUnitGroup)` Updates a `OrgUnitGroup`.
`ResponseMessage`	`updateOrgUnitGroupSet(OrgUnitGroupSet orgUnitGroupSet)` Updates a `OrgUnitGroupSet`.
`ResponseMessage`	`updateTableHook(TableHook tableHook)` Updates a `TableHook`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Dhis2
```
public Dhis2(Dhis2Config dhis2Config)
```
  - Dhis2
```
public Dhis2(Dhis2Config dhis2Config,
             org.springframework.web.client.RestTemplate restTemplate)
```
- Method Detail
  - getStatus
```
public org.springframework.http.HttpStatus getStatus()
```
    Checks the status of the DHIS 2 instance. Returns HttpStatus.OK if available and everything is okay. Returns HttpStatus.NOT_FOUND if the URL to the DHIS 2 instance is invalid or the DHIS 2 instance is not available. Returns a 500 series error if the DHIS 2 instance had an internal error.
    
    Returns:
    
    the HttpStatus of the response from DHIS 2.
  - saveMetadataObject
```
public <T> ResponseMessage saveMetadataObject(String path,
                                              T object)
```
    Saves an object using HTTP POST.
    
    Type Parameters:
    
    T - type.
    
    Parameters:
    
    path - the URL path relative to the API end point.
    
    object - the object to save.
    
    Returns:
    
    a ResponseMessage holding information about the operation.
    
    Throws:
    
    Dhis2ClientException - if the save operation failed due to client side error.
  - updateObject
```
public <T> ResponseMessage updateObject(String path,
                                        T object)
```
    Updates an object using HTTP PUT.
    
    Type Parameters:
    
    T - type.
    
    Parameters:
    
    path - the URL path relative to the API end point.
    
    object - the object to save.
    
    Returns:
    
    a ResponseMessage holding information about the operation.
  - getObject
```
public <T> T getObject(String path,
                       Class<T> klass)
```
    Retrieves an object using HTTP GET.
    
    Type Parameters:
    
    T - type.
    
    Parameters:
    
    path - the URL path relative to the API end point.
    
    klass - the class type of the object.
    
    Returns:
    
    the object.
  - 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.
  - saveOrgUnit
```
public ResponseMessage saveOrgUnit(OrgUnit orgUnit)
```
    Saves a OrgUnit.
    
    Parameters:
    
    orgUnit - the object to save.
    
    Returns:
    
    a ResponseMessage holding information about the operation.
  - updateOrgUnit
```
public ResponseMessage updateOrgUnit(OrgUnit orgUnit)
```
    Updates a OrgUnit.
    
    Parameters:
    
    orgUnit - the object to update.
    
    Returns:
    
    a ResponseMessage holding information about the operation.
  - getOrgUnit
```
public OrgUnit getOrgUnit(String id)
```
    Retrieves an OrgUnit.
    
    Parameters:
    
    id - the object identifier.
    
    Returns:
    
    the OrgUnit.
  - getOrgUnits
```
public List<OrgUnit> getOrgUnits(Query query)
```
    Retrieves a list of OrgUnit.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of OrgUnit.
  - saveOrgUnitGroup
```
public ResponseMessage saveOrgUnitGroup(OrgUnitGroup orgUnitGroup)
```
    Saves a OrgUnitGroup.
    
    Parameters:
    
    orgUnitGroup - the object to save.
    
    Returns:
    
    a ResponseMessage holding information about the operation.
  - updateOrgUnitGroup
```
public ResponseMessage updateOrgUnitGroup(OrgUnitGroup orgUnitGroup)
```
    Updates a OrgUnitGroup.
    
    Parameters:
    
    orgUnitGroup - the object to update.
    
    Returns:
    
    a ResponseMessage holding information about the operation.
  - getOrgUnitGroup
```
public OrgUnitGroup getOrgUnitGroup(String id)
```
    Retrieves an OrgUnitGroup.
    
    Parameters:
    
    id - the object identifier.
    
    Returns:
    
    the OrgUnitGroup.
  - getOrgUnitGroups
```
public List<OrgUnitGroup> getOrgUnitGroups(Query query)
```
    Retrieves a list of OrgUnitGroup.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of OrgUnitGroup.
  - saveOrgUnitGroupSet
```
public ResponseMessage saveOrgUnitGroupSet(OrgUnitGroupSet orgUnitGroupSet)
```
    Saves a OrgUnitGroupSet.
    
    Parameters:
    
    orgUnitGroupSet - the object to save.
    
    Returns:
    
    a ResponseMessage holding information about the operation.
  - updateOrgUnitGroupSet
```
public ResponseMessage updateOrgUnitGroupSet(OrgUnitGroupSet orgUnitGroupSet)
```
    Updates a OrgUnitGroupSet.
    
    Parameters:
    
    orgUnitGroupSet - the object to update.
    
    Returns:
    
    a ResponseMessage holding information about the operation.
  - getOrgUnitGroupSet
```
public OrgUnitGroupSet getOrgUnitGroupSet(String id)
```
    Retrieves an OrgUnitGroupSet.
    
    Parameters:
    
    id - the object identifier.
    
    Returns:
    
    the OrgUnitGroupSet.
  - getOrgUnitGroupSets
```
public List<OrgUnitGroupSet> getOrgUnitGroupSets(Query query)
```
    Retrieves a list of OrgUnitGroupSet.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of OrgUnitGroupSet.
  - getOrgUnitLevel
```
public OrgUnitLevel getOrgUnitLevel(String id)
```
    Retrieves an OrgUnitLevel.
    
    Parameters:
    
    id - the object identifier.
    
    Returns:
    
    the OrgUnitLevel.
  - getOrgUnitLevels
```
public List<OrgUnitLevel> getOrgUnitLevels(Query query)
```
    Retrieves a list of OrgUnitGroupSet.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of OrgUnitGroupSet.
  - getCategory
```
public Category getCategory(String id)
```
    Retrieves an Category.
    
    Parameters:
    
    id - the object identifier.
    
    Returns:
    
    the Category.
  - getCategories
```
public List<Category> getCategories(Query query)
```
    Retrieves a list of Category.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of Category.
  - getCategoryCombo
```
public CategoryCombo getCategoryCombo(String id)
```
    Retrieves an CategoryCombo.
    
    Parameters:
    
    id - the object identifier.
    
    Returns:
    
    the CategoryCombo.
  - getCategoryCombos
```
public List<CategoryCombo> getCategoryCombos(Query query)
```
    Retrieves a list of CategoryCombo.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of CategoryCombo.
  - getDataElement
```
public DataElement getDataElement(String id)
```
    Retrieves an DataElement.
    
    Parameters:
    
    id - the object identifier.
    
    Returns:
    
    the DataElement.
  - getDataElements
```
public List<DataElement> getDataElements(Query query)
```
    Retrieves a list of DataElement.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of DataElement.
  - 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:
    
    a list of DataElementGroupSet.
  - getProgram
```
public Program getProgram(String id)
```
    Retrieves a Program.
    
    Parameters:
    
    id - the object identifier.
    
    Returns:
    
    the Program.
  - getPrograms
```
public List<Program> getPrograms(Query query)
```
    Retrieves a list of Program.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of Program.
  - getCategoryOptionGroupSet
```
public CategoryOptionGroupSet getCategoryOptionGroupSet(String id)
```
    Retrieves an CategoryOptionGroupSet.
    
    Parameters:
    
    id - the object identifier.
    
    Returns:
    
    the CategoryOptionGroupSet.
  - getCategoryOptionGroupSets
```
public List<CategoryOptionGroupSet> getCategoryOptionGroupSets(Query query)
```
    Retrieves a list of CategoryOptionGroupSet.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of CategoryOptionGroupSet.
  - saveTableHook
```
public ResponseMessage saveTableHook(TableHook tableHook)
```
    Saves a TableHook.
    
    Parameters:
    
    tableHook - the object to save.
    
    Returns:
    
    a ResponseMessage holding information about the operation.
  - updateTableHook
```
public ResponseMessage updateTableHook(TableHook tableHook)
```
    Updates a TableHook.
    
    Parameters:
    
    tableHook - the object to update.
    
    Returns:
    
    a ResponseMessage 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.
  - getTableHooks
```
public List<TableHook> getTableHooks(Query query)
```
    Retrieves a list of TableHook.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of TableHook.
  - 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:
    
    a list of Dimension.
  - getPeriodTypes
```
public List<PeriodType> getPeriodTypes(Query query)
```
    Retrieves a list of PeriodType.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of PeriodType.
  - saveDataValueSet
```
public DataValueSetResponseMessage saveDataValueSet(DataValueSet dataValueSet)
```
    Saves a DataValueSet.
    
    Parameters:
    
    dataValueSet - the DataValueSet to save.
    
    Returns:
    
    a DataValueSetResponseMessage holding information about the operation.
    
    Throws:
    
    Dhis2ClientException - if the save operation failed due to a client side error.
  - getJobNotifications
```
public List<JobNotification> getJobNotifications(JobCategory category,
                                                 String id)
```
    Retrieves a list of JobNotification.
    
    Parameters:
    
    category - the JobCategory.
    
    id - the job identifier.
    
    Returns:
    
    a list of JobNotification.

Class Dhis2

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Dhis2

Dhis2

Method Detail

getStatus

saveMetadataObject

updateObject

getObject

objectExists

saveOrgUnit

updateOrgUnit

getOrgUnit

getOrgUnits

saveOrgUnitGroup

updateOrgUnitGroup

getOrgUnitGroup

getOrgUnitGroups

saveOrgUnitGroupSet

updateOrgUnitGroupSet

getOrgUnitGroupSet

getOrgUnitGroupSets

getOrgUnitLevel

getOrgUnitLevels

getCategory

getCategories

getCategoryCombo

getCategoryCombos

getDataElement

getDataElements

getDataElementGroupSet

getDataElementGroupSets

getProgram

getPrograms

getCategoryOptionGroupSet

getCategoryOptionGroupSets

saveTableHook

updateTableHook

getTableHook

getTableHooks

getDimension

getDimensions

getPeriodTypes

saveDataValueSet

getJobNotifications