Dhis2 (DHIS 2 API client for Java and Spring 1.0.0 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.

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
`<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()` Retrieves a list of `OrgUnitGroup`.
`List<OrgUnitGroup>`	`getOrgUnitGroups(Query query)` Retrieves a list of `OrgUnitGroup`.
`OrgUnitGroupSet`	`getOrgUnitGroupSet(String id)` Retrieves an `OrgUnitGroupSet`.
`List<OrgUnitGroupSet>`	`getOrgUnitGroupSets()` Retrieves a list of `OrgUnitGroupSet`.
`List<OrgUnitGroupSet>`	`getOrgUnitGroupSets(Query query)` Retrieves a list of `OrgUnitGroupSet`.
`List<OrgUnit>`	`getOrgUnits()` Retrieves a list of `OrgUnit`.
`List<OrgUnit>`	`getOrgUnits(Query query)` Retrieves a list of `OrgUnit`.
`TableHook`	`getTableHook(String id)` Retrieves an `TableHook`.
`List<TableHook>`	`getTableHooks()` Retrieves a list of `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.
`<T> ResponseMessage`	`saveObject(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
  - saveObject
```
public <T> ResponseMessage saveObject(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.
  - 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 identifier of the org unit.
    
    Returns:
    
    the OrgUnit.
  - getOrgUnits
```
public List<OrgUnit> getOrgUnits()
```
    Retrieves a list of OrgUnit.
    
    Returns:
    
    a list of 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 identifier of the org unit group.
    
    Returns:
    
    the OrgUnitGroup.
  - getOrgUnitGroups
```
public List<OrgUnitGroup> getOrgUnitGroups()
```
    Retrieves a list of OrgUnitGroup.
    
    Returns:
    
    a list of 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 identifier of the org unit group set.
    
    Returns:
    
    the OrgUnitGroupSet.
  - getOrgUnitGroupSets
```
public List<OrgUnitGroupSet> getOrgUnitGroupSets()
```
    Retrieves a list of OrgUnitGroupSet.
    
    Returns:
    
    a list of OrgUnitGroupSet.
  - getOrgUnitGroupSets
```
public List<OrgUnitGroupSet> getOrgUnitGroupSets(Query query)
```
    Retrieves a list of OrgUnitGroupSet.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of OrgUnitGroupSet.
  - 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()
```
    Retrieves a list of TableHook.
    
    Returns:
    
    a list of TableHook.
  - getTableHooks
```
public List<TableHook> getTableHooks(Query query)
```
    Retrieves a list of TableHook.
    
    Parameters:
    
    query - the Query.
    
    Returns:
    
    a list of TableHook.

Class Dhis2

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Dhis2

Dhis2

Method Detail

saveObject

updateObject

getObject

objectExists

saveOrgUnit

updateOrgUnit

getOrgUnit

getOrgUnits

getOrgUnits

saveOrgUnitGroup

updateOrgUnitGroup

getOrgUnitGroup

getOrgUnitGroups

getOrgUnitGroups

saveOrgUnitGroupSet

updateOrgUnitGroupSet

getOrgUnitGroupSet

getOrgUnitGroupSets

getOrgUnitGroupSets

saveTableHook

updateTableHook

getTableHook

getTableHooks

getTableHooks