MdrClient (Samply MDR Client 3.1.0 API)

java.lang.Object
- de.samply.common.mdrclient.MdrClient

```
public class MdrClient
extends Object
```
MDR RESTful interface client.

Field Summary

Fields
Modifier and Type Field and Description

static String PATH_SEPARATOR
Path separator.

Fields
Modifier and Type	Field and Description
`static String`	`PATH_SEPARATOR` Path separator.

Constructor Summary

Constructors
Constructor and Description
`MdrClient()` Create an MdrClient instance with the properties loaded from mdr.properties file.
`MdrClient(String mdrBaseUrl)` Create an MdrClient instance.
`MdrClient(String mdrBaseUrl, jakarta.ws.rs.client.Client client)` Create an MDR client with a readily configured HTTP Client (with proxy settings).
`MdrClient(String mdrBaseUrl, String proxyHost, String proxyPort)` Create a MDR client instance with proxy.
`MdrClient(String mdrBaseUrl, String proxyHost, String proxyPort, String proxyUsername, String proxyPassword)` Create an MDR client instance with proxy authentication.
`MdrClient(String mdrBaseUrl, String proxyHost, String proxyPort, String proxyUsername, String proxyPassword, String proxyRealm)` Create an MDR client instance with proxy authentication and realm.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`cleanCache()` Clean the cache.
`List<Result>`	`filterMembers(List<Result> members, EnumElementType enumElementType)` Filter members by type.
`URI`	`getBaseUri()` Get the MDR RESTful interface base URI.
`Catalogue`	`getCatalogue(String catalogueId, String languageCode)` Get a catalogue by its urn.
`Catalogue`	`getCatalogue(String catalogueId, String languageCode, String accessToken, String userAuthId)` Get a catalogue by its urn.
`Code`	`getCode(String mdrCatalogueId, String mdrCodeId)` Get a code, without authentication.
`Code`	`getCode(String mdrCatalogueId, String mdrCodeId, String accessToken, String userAuthId)` Get a code.
`ArrayList<Slot>`	`getCodeSlots(String mdrCatalogueId, String mdrCodeId)` Get a codes slots, without authentication.
`ArrayList<Slot>`	`getCodeSlots(String mdrCatalogueId, String mdrCodeId, String accessToken, String userAuthId)` Get a codes slots.
`DataElement`	`getDataElement(String mdrDataElementId, String languageCode)` Get the whole DataElement object from the MDR without authentication.
`DataElement`	`getDataElement(String mdrDataElementId, String languageCode, String accessToken, String userAccessToken)` Get the whole DataElement object from the MDR.
`Catalogue`	`getDataElementCatalogue(String mdrDataElementId, String languageCode)` Get a data element catalogue (when applicable).
`Catalogue`	`getDataElementCatalogue(String mdrDataElementId, String languageCode, String accessToken, String userAuthId)` Get a data element catalogue (when applicable).
`Definition`	`getDataElementDefinition(String mdrDataElementId, String languageCode)` Get the designation/definition and the value domain of an MDR data element as `Definition`, without authentication.
`Definition`	`getDataElementDefinition(String mdrDataElementId, String languageCode, String accessToken, String userAccessToken)` Get the designation/definition and the value domain of a MDR data element as `Definition`.
`List<Label>`	`getDataElementGroupLabel(String recordId, String languageCode)` Get dataelementgroup label, without authentication.
`List<Label>`	`getDataElementGroupLabel(String groupId, String languageCode, String accessToken, String userAuthId)` Get dataelementgroup label from the MDR.
`ArrayList<Slot>`	`getDataElementGroupSlots(String mdrDataElementGroupId)` Get a data element group's slots, without authentication.
`ArrayList<Slot>`	`getDataElementGroupSlots(String mdrDataElementGroupId, String accessToken, String userAuthId)` Get a data group's slots.
`List<Result>`	`getDataElementsFromGroup(String mdrGroupId, String languageCode)` Deprecated. no longer supported directly by the MDR. Use `getMembers(String, String)` instead.
`List<Result>`	`getDataElementsFromGroup(String mdrGroupId, String languageCode, String accessToken, String userAuthId)` Deprecated. no longer supported directly by the MDR. Use `getMembers(String, String)` instead.
`ArrayList<Slot>`	`getDataElementSlots(String mdrDataElementId)` Get a data element's slots, without authentication.
`ArrayList<Slot>`	`getDataElementSlots(String mdrDataElementId, String accessToken, String userAuthId)` Get a data element's slots.
`Validations`	`getDataElementValidations(String mdrDataElementId, String languageCode)` Get a data element's validations, without authentication.
`Validations`	`getDataElementValidations(String mdrDataElementId, String languageCode, String accessToken, String userAuthId)` Get a data element's validations.
`protected String`	`getJson(String path, String languageCode)` Get a JSON response, tries to load data from the cache first, without authentication.
`protected String`	`getJson(String path, String languageCode, String accessToken, String userAuthId)` Get a JSON response, tries to load data from the cache first.
`protected String`	`getJsonCatalogue(String catalogueId, String languageCode, String accessToken, String userAuthId)` Get the JSON string representation of a catalogue from the given catalog URN.
`protected String`	`getJsonCode(String mdrCatalogueId, String mdrCodeId, String accessToken, String userAuthId)` Get a codes from the MDR.
`protected String`	`getJsonCodeSlots(String mdrCatalogueId, String mdrCodeId, String accessToken, String userAuthId)` Get a codes slots from the MDR.
`protected String`	`getJsonDataElement(String mdrDataElementId, String languageCode, String accessToken, String userAuthId)` Get the whole DataElement as a JSON object from the MDR.
`protected String`	`getJsonDataElementCatalogue(String mdrDataElementId, String languageCode, String accessToken, String userAuthId)` Get the JSON string representation of the catalogue from the given data element.
`protected String`	`getJsonDataElementDefinition(String mdrDataElementId, String languageCode, String accessToken, String userAuthId)` Get the designation/definition and the value domain of an MDR data element as JSON.
`protected String`	`getJsonDataElementGroupSlots(String mdrDataElementGroupId, String accessToken, String userAuthId)` Get a data element group's slots from the MDR.
`protected String`	`getJsonDataElementSlots(String mdrDataElementId, String accessToken, String userAuthId)` Get a data element's slots from the MDR.
`protected String`	`getJsonDataElementValidations(String mdrDataElementId, String languageCode, String accessToken, String userAuthId)` Get a data element's validations.
`protected String`	`getJsonLabel(String memberId, String languageCode, EnumElementType enumElementType, String accessToken, String userAuthId)` Get the label of an MDR element as JSON string.
`protected String`	`getJsonMembers(String mdrGroupId, String languageCode, String accessToken, String userAuthId)` Get all the data elements from a group defined in the MDR as JSON string.
`protected String`	`getJsonNamespaceMembers(String languageCode, String accessToken, String userAuthId, String namespace)` Get elements from a namespace (e.g.
`protected String`	`getJsonNamespaces(String languageCode, String accessToken, String userAuthId)` Get all available namespaces as JSON.
`protected String`	`getJsonRecordDefinition(String mdrRecordId, String languageCode, String accessToken, String userAuthId)` Get the designation/definition and the value domain of an MDR record as JSON.
`protected String`	`getJsonRecordMembers(String mdrGroupId, String languageCode, String accessToken, String userAuthId)` Get all the data elements from a record defined in the MDR as JSON string.
`protected String`	`getJsonRecordSlots(String mdrRecordId, String accessToken, String userAuthId)` Gets a record's slots from the MDR.
`protected String`	`getJsonSearch(String searchText, String languageCode, String accessToken, String namespace)` Search for data that are related to the given search text.
`protected String`	`getJsonSearchLocal(String searchText, String languageCode, String accessToken)` Search for data that are related to the given search text.
`List<Result>`	`getMembers(String mdrGroupId, String languageCode)` Get the members of a given group defined in the MDR, not authenticated.
`List<Result>`	`getMembers(String mdrGroupId, String languageCode, String accessToken, String userAuthId)` Get the members of a given group defined in the MDR.
`List<Result>`	`getNamespaceMembers(String languageCode, String namespace)` Get the root groups from the MDR (e.g.
`List<Result>`	`getNamespaceMembers(String languageCode, String accessToken, String userAuthId, String namespace)` Get the root groups from the MDR (e.g.
`List<Namespace>`	`getNamespaces(String languageCode)` Get the namespeaces from the MDR, without authentication.
`List<Namespace>`	`getNamespaces(String languageCode, String accessToken, String userAuthId)` Get the namespeaces from the MDR.
`RecordDefinition`	`getRecordDefinition(String mdrRecordId, String languageCode)` Get the designation/definition and the value domain of an MDR record as `RecordDefinition`, without authentication.
`RecordDefinition`	`getRecordDefinition(String mdrRecordId, String languageCode, String accessToken, String userAccessToken)` Get the designation/definition and the value domain of a MDR record as `RecordDefinition`.
`List<Label>`	`getRecordLabel(String recordId, String languageCode)` Get record label, without authentication.
`List<Label>`	`getRecordLabel(String recordId, String languageCode, String accessToken, String userAuthId)` Get record label from the MDR.
`List<Result>`	`getRecordMembers(String recordId, String languageCode)` Get the members of a given record defined in the MDR without authentication.
`List<Result>`	`getRecordMembers(String recordId, String languageCode, String accessToken, String userAuthId)` Get the members of a given record defined in the MDR.
`ArrayList<Slot>`	`getRecordSlots(String mdrRecordId)` Gets the slots of a record without authentication.
`ArrayList<Slot>`	`getRecordSlots(String mdrRecordId, String accessToken, String userAuthId)` Gets the slots of a record.
`protected String`	`getUserJsonRootElements(String languageCode, String accessToken, String userAuthId)` Get the root elements from the MDR for a specific user (e.g.
`ResultList`	`getUserNamespaceRepresentations(String mdrDataElementId, String accessToken, String userAuthId)` Get the representations of a dataelement for a specific users namespace.
`ResultList`	`getUserRootElements(String languageCode, String accessToken, String userAuthId)` Get the root elements from the MDR for a specific user.
`List<Result>`	`search(String searchText, String languageCode, String accessToken)` Search for data that is related to the given search text.
`List<Result>`	`searchInNamespace(String searchText, String languageCode, String accessToken, String namespace)` Search for data that is related to the given search text.
`List<Result>`	`searchLocal(String searchText, String languageCode, String accessToken)` Search for data that is related to the given search text.

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

- Field Detail
  - PATH_SEPARATOR
```
public static final String PATH_SEPARATOR
```
    Path separator.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MdrClient
```
public MdrClient()
```
    Create an MdrClient instance with the properties loaded from mdr.properties file.
  - MdrClient
```
public MdrClient(String mdrBaseUrl)
```
    Create an MdrClient instance. Use MdrClient(String, String, String) instead in case a proxy is necessary to contact the MDR client.
    
    Parameters:
    
    mdrBaseUrl - the MDR REST interface base URL
  - MdrClient
```
public MdrClient(String mdrBaseUrl,
                 String proxyHost,
                 String proxyPort)
```
    Create a MDR client instance with proxy.
    
    Parameters:
    
    mdrBaseUrl - the MDR REST interface base URL
    
    proxyHost - the proxy host
    
    proxyPort - the proxy port
  - MdrClient
```
public MdrClient(String mdrBaseUrl,
                 String proxyHost,
                 String proxyPort,
                 String proxyUsername,
                 String proxyPassword)
```
    Create an MDR client instance with proxy authentication.
    
    Parameters:
    
    mdrBaseUrl - the MDR REST interface base URL
    
    proxyHost - the MDR REST interface proxy host
    
    proxyPort - the MDR REST interface proxy port
    
    proxyUsername - the MDR REST interface proxy user name
    
    proxyPassword - the MDR REST interface proxy password
  - MdrClient
```
public MdrClient(String mdrBaseUrl,
                 String proxyHost,
                 String proxyPort,
                 String proxyUsername,
                 String proxyPassword,
                 String proxyRealm)
```
    Create an MDR client instance with proxy authentication and realm.
    
    Parameters:
    
    mdrBaseUrl - the MDR REST interface base URL
    
    proxyHost - the MDR REST interface proxy host
    
    proxyPort - the MDR REST interface proxy port
    
    proxyUsername - the MDR REST interface proxy user name
    
    proxyPassword - the MDR REST interface proxy password
    
    proxyRealm - the MDR REST interface proxy realm name
  - MdrClient
```
public MdrClient(String mdrBaseUrl,
                 jakarta.ws.rs.client.Client client)
```
    Create an MDR client with a readily configured HTTP Client (with proxy settings).
    
    Parameters:
    
    mdrBaseUrl - the MDR URL
    
    client - a jersey webclient
- Method Detail
  - getJsonLabel
```
protected final String getJsonLabel(String memberId,
                                    String languageCode,
                                    EnumElementType enumElementType,
                                    String accessToken,
                                    String userAuthId)
                             throws MdrConnectionException,
                                    ExecutionException
```
    Get the label of an MDR element as JSON string.
    
    Parameters:
    
    memberId - e.g. "urn:mdr:record:1:1"
    
    languageCode - e.g. "de".
    
    enumElementType - type of the data element EnumElementType
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    JSON string representation of the data elements from the selected record
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
  - getRecordLabel
```
public final List<Label> getRecordLabel(String recordId,
                                        String languageCode)
                                 throws MdrConnectionException,
                                        ExecutionException
```
    Get record label, without authentication.
    
    Parameters:
    
    recordId - e.g. "urn:mdr:record:1:1 (a test record)"
    
    languageCode - e.g. "de".
    
    Returns:
    
    the members of a record
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
    
    See Also:
    
    getRecordLabel(String, String, String, String)
  - getRecordLabel
```
public final List<Label> getRecordLabel(String recordId,
                                        String languageCode,
                                        String accessToken,
                                        String userAuthId)
                                 throws MdrConnectionException,
                                        ExecutionException
```
    Get record label from the MDR.
    
    Parameters:
    
    recordId - e.g. "urn:mdr:record:1:1 (a test record)"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    the members of a record - data elements
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
  - getDataElementGroupLabel
```
public final List<Label> getDataElementGroupLabel(String recordId,
                                                  String languageCode)
                                           throws MdrConnectionException,
                                                  ExecutionException
```
    Get dataelementgroup label, without authentication.
    
    Parameters:
    
    recordId - e.g. "urn:mdr:dataelementgroup:1:1 (a test record)"
    
    languageCode - e.g. "de".
    
    Returns:
    
    the members of a dataelementgroup
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
    
    See Also:
    
    getDataElementGroupLabel(String, String, String, String)
  - getDataElementGroupLabel
```
public final List<Label> getDataElementGroupLabel(String groupId,
                                                  String languageCode,
                                                  String accessToken,
                                                  String userAuthId)
                                           throws MdrConnectionException,
                                                  ExecutionException
```
    Get dataelementgroup label from the MDR.
    
    Parameters:
    
    groupId - e.g. "urn:mdr:dataelementgroup:1:1 (a test record)"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    the members of a dataelementgroup
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
  - getRecordSlots
```
public final ArrayList<Slot> getRecordSlots(String mdrRecordId)
                                     throws MdrConnectionException,
                                            MdrInvalidResponseException,
                                            ExecutionException
```
    Gets the slots of a record without authentication.
    
    Parameters:
    
    mdrRecordId - e.g. "urn:mdr:record:1:1 (a test record)"
    
    Returns:
    
    the slots of the record
    
    Throws:
    
    MdrConnectionException - Todo.
    
    MdrInvalidResponseException - Todo.
    
    ExecutionException - Todo.
    
    See Also:
    
    getRecordSlots(String, String, String)
  - getRecordSlots
```
public final ArrayList<Slot> getRecordSlots(String mdrRecordId,
                                            String accessToken,
                                            String userAuthId)
                                     throws MdrConnectionException,
                                            MdrInvalidResponseException,
                                            ExecutionException
```
    Gets the slots of a record.
    
    Parameters:
    
    mdrRecordId - e.g. "urn:mdr:record:1:1 (a test record)"
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    the slots of the record
    
    Throws:
    
    MdrConnectionException - Todo.
    
    MdrInvalidResponseException - Todo.
    
    ExecutionException - Todo.
  - getJsonRecordMembers
```
protected final String getJsonRecordMembers(String mdrGroupId,
                                            String languageCode,
                                            String accessToken,
                                            String userAuthId)
                                     throws MdrConnectionException,
                                            ExecutionException
```
    Get all the data elements from a record defined in the MDR as JSON string.
    
    Parameters:
    
    mdrGroupId - e.g. "urn:mdr:record:1:1 (a test record)"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    JSON string representation of the data elements from the selected record
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
  - getRecordMembers
```
public final List<Result> getRecordMembers(String recordId,
                                           String languageCode)
                                    throws MdrConnectionException,
                                           ExecutionException
```
    Get the members of a given record defined in the MDR without authentication.
    
    Parameters:
    
    recordId - e.g. "urn:mdr:record:1:1 (a test record)"
    
    languageCode - e.g. "de".
    
    Returns:
    
    the members of a record
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
    
    See Also:
    
    getRecordMembers(String, String, String, String)
  - getRecordMembers
```
public final List<Result> getRecordMembers(String recordId,
                                           String languageCode,
                                           String accessToken,
                                           String userAuthId)
                                    throws MdrConnectionException,
                                           ExecutionException
```
    Get the members of a given record defined in the MDR.
    
    Parameters:
    
    recordId - e.g. "urn:mdr:record:1:1 (a test record)"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    the members of a record
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
  - getJsonMembers
```
protected final String getJsonMembers(String mdrGroupId,
                                      String languageCode,
                                      String accessToken,
                                      String userAuthId)
                               throws MdrConnectionException,
                                      ExecutionException
```
    Get all the data elements from a group defined in the MDR as JSON string.
    
    Parameters:
    
    mdrGroupId - e.g. "urn:mdr:dataelementgroup:1:1 (for MDS-K)"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    JSON string representation of the data elements from the selected group
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
  - getMembers
```
public final List<Result> getMembers(String mdrGroupId,
                                     String languageCode)
                              throws MdrConnectionException,
                                     ExecutionException
```
    Get the members of a given group defined in the MDR, not authenticated.
    
    Parameters:
    
    mdrGroupId - e.g. "urn:mdr:dataelementgroup:1:1 (for MDS-K)"
    
    languageCode - e.g. "de".
    
    Returns:
    
    the subgroups of a group
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
    
    See Also:
    
    getMembers(String, String, String, String)
  - getMembers
```
public final List<Result> getMembers(String mdrGroupId,
                                     String languageCode,
                                     String accessToken,
                                     String userAuthId)
                              throws MdrConnectionException,
                                     ExecutionException
```
    Get the members of a given group defined in the MDR.
    
    Parameters:
    
    mdrGroupId - e.g. "urn:mdr:dataelementgroup:1:1 (for MDS-K)"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    the subgroups of a group
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
  - getJson
```
protected final String getJson(String path,
                               String languageCode)
                        throws ExecutionException
```
    Get a JSON response, tries to load data from the cache first, without authentication.
    
    Parameters:
    
    path - MDR REST interface path to be called
    
    languageCode - e.g. "de".
    
    Returns:
    
    the JSON string representation of MDR reply to the given parameters (possibly cached)
    
    Throws:
    
    ExecutionException - if there is an execution error
  - getJson
```
protected final String getJson(String path,
                               String languageCode,
                               String accessToken,
                               String userAuthId)
                        throws ExecutionException
```
    Get a JSON response, tries to load data from the cache first.
    
    Parameters:
    
    path - MDR REST interface path to be called
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    the JSON string representation of MDR reply to the given parameters (possibly cached)
    
    Throws:
    
    ExecutionException - if there is an execution error
  - getDataElementsFromGroup
```
@Deprecated
public final List<Result> getDataElementsFromGroup(String mdrGroupId,
                                                                String languageCode)
                                                         throws MdrConnectionException,
                                                                ExecutionException
```
    Deprecated. no longer supported directly by the MDR. Use getMembers(String, String) instead.
    
    Get all the data elements from a group defined in the MDR, without authentication.
    
    Parameters:
    
    mdrGroupId - e.g. "urn:mdr:dataelementgroup:1:1 (for MDS-K)"
    
    languageCode - e.g. "de".
    
    Returns:
    
    data elements from the selected group
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
    
    See Also:
    
    getDataElementsFromGroup(String, String, String, String)
  - getDataElementsFromGroup
```
@Deprecated
public final List<Result> getDataElementsFromGroup(String mdrGroupId,
                                                                String languageCode,
                                                                String accessToken,
                                                                String userAuthId)
                                                         throws MdrConnectionException,
                                                                ExecutionException
```
    Deprecated. no longer supported directly by the MDR. Use getMembers(String, String) instead.
    
    Get all the data elements from a group defined in the MDR.
    
    Parameters:
    
    mdrGroupId - e.g. "urn:mdr:dataelementgroup:1:1 (for MDS-K)"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    data elements from the selected group
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    ExecutionException - if there is an execution error
  - getJsonDataElementValidations
```
protected final String getJsonDataElementValidations(String mdrDataElementId,
                                                     String languageCode,
                                                     String accessToken,
                                                     String userAuthId)
                                              throws MdrConnectionException,
                                                     MdrInvalidResponseException,
                                                     ExecutionException
```
    Get a data element's validations.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    JSON string representation of validations from the given MDR data element ID
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - the MDR response is not valid.
    
    ExecutionException - if there is an execution error
  - getJsonDataElementCatalogue
```
protected final String getJsonDataElementCatalogue(String mdrDataElementId,
                                                   String languageCode,
                                                   String accessToken,
                                                   String userAuthId)
                                            throws MdrConnectionException,
                                                   MdrInvalidResponseException,
                                                   ExecutionException
```
    Get the JSON string representation of the catalogue from the given data element.
    
    Parameters:
    
    mdrDataElementId - data element that has a catalogue e.g. "urn:test:dataelement:3:1"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of the catalogue from the given MDR data element ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - getJsonCatalogue
```
protected final String getJsonCatalogue(String catalogueId,
                                        String languageCode,
                                        String accessToken,
                                        String userAuthId)
                                 throws MdrConnectionException,
                                        MdrInvalidResponseException,
                                        ExecutionException
```
    Get the JSON string representation of a catalogue from the given catalog URN.
    
    Parameters:
    
    catalogueId - urn of the catalogue e.g. "urn:test:catalog:1:1"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of the catalogue with the given catalogue ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - getJsonDataElementSlots
```
protected final String getJsonDataElementSlots(String mdrDataElementId,
                                               String accessToken,
                                               String userAuthId)
                                        throws MdrConnectionException,
                                               MdrInvalidResponseException,
                                               ExecutionException
```
    Get a data element's slots from the MDR.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1:0"
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of slots from the given MDR data element ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error
  - getJsonDataElementGroupSlots
```
protected final String getJsonDataElementGroupSlots(String mdrDataElementGroupId,
                                                    String accessToken,
                                                    String userAuthId)
                                             throws MdrConnectionException,
                                                    MdrInvalidResponseException,
                                                    ExecutionException
```
    Get a data element group's slots from the MDR.
    
    Parameters:
    
    mdrDataElementGroupId - e.g. "urn:mdr:dataelementgroup:2:1:0"
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of slots from the given MDR data element ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error
  - getJsonRecordSlots
```
protected final String getJsonRecordSlots(String mdrRecordId,
                                          String accessToken,
                                          String userAuthId)
                                   throws MdrConnectionException,
                                          MdrInvalidResponseException,
                                          ExecutionException
```
    Gets a record's slots from the MDR.
    
    Parameters:
    
    mdrRecordId - e.g. "urn:mdr:record:1:1"
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of slots from the given MDR record ID.
    
    Throws:
    
    MdrConnectionException - Todo.
    
    MdrInvalidResponseException - Todo.
    
    ExecutionException - Todo.
  - getJsonCodeSlots
```
protected final String getJsonCodeSlots(String mdrCatalogueId,
                                        String mdrCodeId,
                                        String accessToken,
                                        String userAuthId)
                                 throws MdrConnectionException,
                                        MdrInvalidResponseException,
                                        ExecutionException
```
    Get a codes slots from the MDR.
    
    Parameters:
    
    mdrCatalogueId - e.g. "urn:mdr:catalog:1:1"
    
    mdrCodeId - e.g. "urn:mdr:code:2:1.0"
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of slots from the given MDR code ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error
  - getDataElementSlots
```
public final ArrayList<Slot> getDataElementSlots(String mdrDataElementId)
                                          throws MdrConnectionException,
                                                 MdrInvalidResponseException,
                                                 ExecutionException
```
    Get a data element's slots, without authentication.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    Returns:
    
    JSON string representation of slots from the given MDR data element ID
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - the MDR response is not valid.
    
    ExecutionException - if there is an execution error
    
    See Also:
    
    getDataElementSlots(String, String, String)
  - getDataElementSlots
```
public final ArrayList<Slot> getDataElementSlots(String mdrDataElementId,
                                                 String accessToken,
                                                 String userAuthId)
                                          throws MdrConnectionException,
                                                 MdrInvalidResponseException,
                                                 ExecutionException
```
    Get a data element's slots.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    JSON string representation of slots from the given MDR data element ID
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - the MDR response is not valid.
    
    ExecutionException - if there is an execution error
  - getDataElementGroupSlots
```
public final ArrayList<Slot> getDataElementGroupSlots(String mdrDataElementGroupId)
                                               throws MdrConnectionException,
                                                      MdrInvalidResponseException,
                                                      ExecutionException
```
    Get a data element group's slots, without authentication.
    
    Parameters:
    
    mdrDataElementGroupId - e.g. "urn:mdr:datagroup:2:1.0"
    
    Returns:
    
    JSON string representation of slots from the given MDR data element ID
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - the MDR response is not valid.
    
    ExecutionException - if there is an execution error
    
    See Also:
    
    getDataElementGroupSlots(String, String, String)
  - getDataElementGroupSlots
```
public final ArrayList<Slot> getDataElementGroupSlots(String mdrDataElementGroupId,
                                                      String accessToken,
                                                      String userAuthId)
                                               throws MdrConnectionException,
                                                      MdrInvalidResponseException,
                                                      ExecutionException
```
    Get a data group's slots.
    
    Parameters:
    
    mdrDataElementGroupId - e.g. "urn:mdr:datagroup:2:1.0"
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    JSON string representation of slots from the given MDR data element ID
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - the MDR response is not valid.
    
    ExecutionException - if there is an execution error
  - getCode
```
public final Code getCode(String mdrCatalogueId,
                          String mdrCodeId)
                   throws MdrConnectionException,
                          MdrInvalidResponseException,
                          ExecutionException
```
    Get a code, without authentication.
    
    Parameters:
    
    mdrCatalogueId - e.g. "urn:mdr:catalog:1:1"
    
    mdrCodeId - e.g. "urn:mdr:code:2:1.0"
    
    Returns:
    
    the code
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - the MDR response is not valid.
    
    ExecutionException - if there is an execution error
    
    See Also:
    
    getCode(String, String, String, String)
  - getCode
```
public final Code getCode(String mdrCatalogueId,
                          String mdrCodeId,
                          String accessToken,
                          String userAuthId)
                   throws MdrConnectionException,
                          MdrInvalidResponseException,
                          ExecutionException
```
    Get a code.
    
    Parameters:
    
    mdrCatalogueId - e.g. "urn:mdr:catalog:1:1"
    
    mdrCodeId - e.g. "urn:mdr:code:2:1.0"
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication monitor id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    the code
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - the MDR response is not valid.
    
    ExecutionException - if there is an execution error
  - getJsonCode
```
protected final String getJsonCode(String mdrCatalogueId,
                                   String mdrCodeId,
                                   String accessToken,
                                   String userAuthId)
                            throws MdrConnectionException,
                                   MdrInvalidResponseException,
                                   ExecutionException
```
    Get a codes from the MDR.
    
    Parameters:
    
    mdrCatalogueId - e.g. "urn:mdr:catalog:1:1"
    
    mdrCodeId - e.g. "urn:mdr:code:2:1.0"
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication monitor id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of slots from the given MDR code ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error
  - getCodeSlots
```
public final ArrayList<Slot> getCodeSlots(String mdrCatalogueId,
                                          String mdrCodeId)
                                   throws MdrConnectionException,
                                          MdrInvalidResponseException,
                                          ExecutionException
```
    Get a codes slots, without authentication.
    
    Parameters:
    
    mdrCatalogueId - e.g. "urn:mdr:catalog:1:1"
    
    mdrCodeId - e.g. "urn:mdr:code:2:1.0"
    
    Returns:
    
    JSON string representation of slots from the given MDR code ID
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - the MDR response is not valid.
    
    ExecutionException - if there is an execution error
    
    See Also:
    
    getCodeSlots(String, String, String, String)
  - getCodeSlots
```
public final ArrayList<Slot> getCodeSlots(String mdrCatalogueId,
                                          String mdrCodeId,
                                          String accessToken,
                                          String userAuthId)
                                   throws MdrConnectionException,
                                          MdrInvalidResponseException,
                                          ExecutionException
```
    Get a codes slots.
    
    Parameters:
    
    mdrCatalogueId - e.g. "urn:mdr:catalog:1:1"
    
    mdrCodeId - e.g. "urn:mdr:code:2:1.0"
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions.
    
    Returns:
    
    JSON string representation of slots from the given MDR code ID
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - the MDR response is not valid.
    
    ExecutionException - if there is an execution error
  - getJsonSearch
```
protected final String getJsonSearch(String searchText,
                                     String languageCode,
                                     String accessToken,
                                     String namespace)
                              throws MdrConnectionException,
                                     MdrInvalidResponseException,
                                     ExecutionException
```
    Search for data that are related to the given search text.
    
    Parameters:
    
    searchText - the text to search for
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    namespace - the namespace to search in. can be omitted to search in own namespace
    
    Returns:
    
    JSON string representation of a search
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    MdrInvalidResponseException - if an invalid response is retrieved from the MDR
    
    ExecutionException - if there is an execution error
  - getJsonSearchLocal
```
protected final String getJsonSearchLocal(String searchText,
                                          String languageCode,
                                          String accessToken)
                                   throws MdrConnectionException,
                                          MdrInvalidResponseException,
                                          ExecutionException
```
    Search for data that are related to the given search text.
    
    Parameters:
    
    searchText - the text to search for
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of a search
    
    Throws:
    
    MdrConnectionException - if there is an error while connecting to the MDR
    
    MdrInvalidResponseException - if an invalid response is retrieved from the MDR
    
    ExecutionException - if there is an execution error
  - getDataElementValidations
```
public final Validations getDataElementValidations(String mdrDataElementId,
                                                   String languageCode)
                                            throws MdrConnectionException,
                                                   MdrInvalidResponseException,
                                                   ExecutionException
```
    Get a data element's validations, without authentication.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    languageCode - e.g. "de".
    
    Returns:
    
    JSON string representation of validations from the given MDR data element ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
    
    See Also:
    
    getDataElementValidations(String, String, String, String)
  - getDataElementValidations
```
public final Validations getDataElementValidations(String mdrDataElementId,
                                                   String languageCode,
                                                   String accessToken,
                                                   String userAuthId)
                                            throws MdrConnectionException,
                                                   MdrInvalidResponseException,
                                                   ExecutionException
```
    Get a data element's validations.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of validations from the given MDR data element ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - getDataElementCatalogue
```
public final Catalogue getDataElementCatalogue(String mdrDataElementId,
                                               String languageCode)
                                        throws MdrConnectionException,
                                               MdrInvalidResponseException,
                                               ExecutionException
```
    Get a data element catalogue (when applicable).
    
    Parameters:
    
    mdrDataElementId - data element that has a catalogue e.g. "urn:test:dataelement:3:1"
    
    languageCode - e.g. "de".
    
    Returns:
    
    The catalogue of the given data element.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - getDataElementCatalogue
```
public final Catalogue getDataElementCatalogue(String mdrDataElementId,
                                               String languageCode,
                                               String accessToken,
                                               String userAuthId)
                                        throws MdrConnectionException,
                                               MdrInvalidResponseException,
                                               ExecutionException
```
    Get a data element catalogue (when applicable).
    
    Parameters:
    
    mdrDataElementId - data element that has a catalogue e.g. "urn:test:dataelement:3:1"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    The catalogue of the given data element.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - getCatalogue
```
public final Catalogue getCatalogue(String catalogueId,
                                    String languageCode)
                             throws MdrConnectionException,
                                    MdrInvalidResponseException,
                                    ExecutionException
```
    Get a catalogue by its urn.
    
    Parameters:
    
    catalogueId - urn of the catalogue e.g. "urn:test:catalog:1:1"
    
    languageCode - e.g. "de".
    
    Returns:
    
    The catalogue with the given catalogueId.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - getCatalogue
```
public final Catalogue getCatalogue(String catalogueId,
                                    String languageCode,
                                    String accessToken,
                                    String userAuthId)
                             throws MdrConnectionException,
                                    MdrInvalidResponseException,
                                    ExecutionException
```
    Get a catalogue by its urn.
    
    Parameters:
    
    catalogueId - urn of the catalogue e.g. "urn:test:catalog:1:1"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    The catalogue with the given catalogueId.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - search
```
public final List<Result> search(String searchText,
                                 String languageCode,
                                 String accessToken)
                          throws MdrConnectionException,
                                 MdrInvalidResponseException,
                                 ExecutionException
```
    Search for data that is related to the given search text. It searches only on data that the user has access to.
    
    Parameters:
    
    searchText - the text to search for
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    Returns:
    
    search results
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - searchInNamespace
```
public final List<Result> searchInNamespace(String searchText,
                                            String languageCode,
                                            String accessToken,
                                            String namespace)
                                     throws MdrConnectionException,
                                            MdrInvalidResponseException,
                                            ExecutionException
```
    Search for data that is related to the given search text. It searches in the given namespace which has to be publicly accesible.
    
    Parameters:
    
    searchText - the text to search for
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    namespace - the namespace to search in.
    
    Returns:
    
    search results
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - searchLocal
```
public final List<Result> searchLocal(String searchText,
                                      String languageCode,
                                      String accessToken)
                               throws MdrConnectionException,
                                      MdrInvalidResponseException,
                                      ExecutionException
```
    Search for data that is related to the given search text. It searches in all local namespaces.
    
    Parameters:
    
    searchText - the text to search for
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    Returns:
    
    search results
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - getJsonDataElementDefinition
```
protected final String getJsonDataElementDefinition(String mdrDataElementId,
                                                    String languageCode,
                                                    String accessToken,
                                                    String userAuthId)
                                             throws MdrConnectionException,
                                                    MdrInvalidResponseException,
                                                    ExecutionException
```
    Get the designation/definition and the value domain of an MDR data element as JSON.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of the complete metadata set of a data element.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - getJsonDataElement
```
protected final String getJsonDataElement(String mdrDataElementId,
                                          String languageCode,
                                          String accessToken,
                                          String userAuthId)
                                   throws MdrConnectionException,
                                          MdrInvalidResponseException,
                                          ExecutionException
```
    Get the whole DataElement as a JSON object from the MDR.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of the complete data element.
    
    Throws:
    
    MdrConnectionException
    
    MdrInvalidResponseException
    
    ExecutionException
  - getJsonRecordDefinition
```
protected final String getJsonRecordDefinition(String mdrRecordId,
                                               String languageCode,
                                               String accessToken,
                                               String userAuthId)
                                        throws MdrConnectionException,
                                               MdrInvalidResponseException,
                                               ExecutionException
```
    Get the designation/definition and the value domain of an MDR record as JSON.
    
    Parameters:
    
    mdrRecordId - e.g. "urn:mdr:record:2:1.0"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of the complete metadata set of a record.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - getDataElementDefinition
```
public final Definition getDataElementDefinition(String mdrDataElementId,
                                                 String languageCode)
                                          throws MdrConnectionException,
                                                 MdrInvalidResponseException,
                                                 ExecutionException
```
    Get the designation/definition and the value domain of an MDR data element as Definition, without authentication.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    languageCode - e.g. "de".
    
    Returns:
    
    JSON string representation of validations from the given MDR data element ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
    
    See Also:
    
    getDataElementDefinition(String, String, String, String)
  - getDataElementDefinition
```
public final Definition getDataElementDefinition(String mdrDataElementId,
                                                 String languageCode,
                                                 String accessToken,
                                                 String userAccessToken)
                                          throws MdrConnectionException,
                                                 MdrInvalidResponseException,
                                                 ExecutionException
```
    Get the designation/definition and the value domain of a MDR data element as Definition.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAccessToken - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of validations from the given MDR data element ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - getRecordDefinition
```
public final RecordDefinition getRecordDefinition(String mdrRecordId,
                                                  String languageCode)
                                           throws MdrConnectionException,
                                                  MdrInvalidResponseException,
                                                  ExecutionException
```
    Get the designation/definition and the value domain of an MDR record as RecordDefinition, without authentication.
    
    Parameters:
    
    mdrRecordId - e.g. "urn:osse-123:record:2:1"
    
    languageCode - e.g. "de".
    
    Returns:
    
    JSON string representation of validations from the given MDR record ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
    
    See Also:
    
    getRecordDefinition(String, String, String, String)
  - getRecordDefinition
```
public final RecordDefinition getRecordDefinition(String mdrRecordId,
                                                  String languageCode,
                                                  String accessToken,
                                                  String userAccessToken)
                                           throws MdrConnectionException,
                                                  MdrInvalidResponseException,
                                                  ExecutionException
```
    Get the designation/definition and the value domain of a MDR record as RecordDefinition.
    
    Parameters:
    
    mdrRecordId - e.g. "urn:osse-123:record:2:1"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAccessToken - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    JSON string representation of validations from the given MDR record ID.
    
    Throws:
    
    MdrConnectionException - if there was an error communicating with the MDR.
    
    MdrInvalidResponseException - if the MDR response is not valid.
    
    ExecutionException - if there is an execution error.
  - filterMembers
```
public final List<Result> filterMembers(List<Result> members,
                                        EnumElementType enumElementType)
```
    Filter members by type. The MDR no longer supports /subrgroups and /entries, so all types are returned in the same list. To easily get specific EnumElementType from an element result list, use this method.
    
    Parameters:
    
    members - a list of MDR members.
    
    enumElementType - type of the members list returned.
    
    Returns:
    
    list of members of the given type.
  - getJsonNamespaces
```
protected final String getJsonNamespaces(String languageCode,
                                         String accessToken,
                                         String userAuthId)
                                  throws ExecutionException
```
    Get all available namespaces as JSON.
    
    Parameters:
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    the list of namespaces as JSON string.
    
    Throws:
    
    ExecutionException - if there is an execution error.
  - getJsonNamespaceMembers
```
protected final String getJsonNamespaceMembers(String languageCode,
                                               String accessToken,
                                               String userAuthId,
                                               String namespace)
                                        throws ExecutionException
```
    Get elements from a namespace (e.g. MDS-K, CPP-IT) as JSON.
    
    Parameters:
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    namespace - the namespace from which members will be queried.
    
    Returns:
    
    the namespace elements (such as MDS-K, CPP-IT) as JSON string.
    
    Throws:
    
    ExecutionException - if there is an execution error.
  - getUserJsonRootElements
```
protected final String getUserJsonRootElements(String languageCode,
                                               String accessToken,
                                               String userAuthId)
                                        throws ExecutionException
```
    Get the root elements from the MDR for a specific user (e.g. MDS-K, CPP-IT) as JSON.
    
    Parameters:
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    the root elements for a specific user (such as MDS-K, CPP-IT) as JSON string.
    
    Throws:
    
    ExecutionException - if there is an execution error.
  - getNamespaces
```
public final List<Namespace> getNamespaces(String languageCode)
                                    throws ExecutionException
```
    Get the namespeaces from the MDR, without authentication.
    
    Parameters:
    
    languageCode - e.g. "de".
    
    Returns:
    
    the namespaces.
    
    Throws:
    
    ExecutionException - if there is an execution error.
    
    See Also:
    
    getNamespaces(String, String, String)
  - getNamespaces
```
public final List<Namespace> getNamespaces(String languageCode,
                                           String accessToken,
                                           String userAuthId)
                                    throws ExecutionException
```
    Get the namespeaces from the MDR.
    
    Parameters:
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    the namespaces.
    
    Throws:
    
    ExecutionException - if there is an execution error.
  - getNamespaceMembers
```
public final List<Result> getNamespaceMembers(String languageCode,
                                              String namespace)
                                       throws ExecutionException
```
    Get the root groups from the MDR (e.g. MDS-K, CPP-IT), without authentication.
    
    Parameters:
    
    languageCode - e.g. "de".
    
    namespace - the namespace from which members will be queried.
    
    Returns:
    
    the root groups (such as MDS-K, CPP-IT).
    
    Throws:
    
    ExecutionException - if there is an execution error.
    
    See Also:
    
    getNamespaceMembers(String, String, String, String)
  - getNamespaceMembers
```
public final List<Result> getNamespaceMembers(String languageCode,
                                              String accessToken,
                                              String userAuthId,
                                              String namespace)
                                       throws ExecutionException
```
    Get the root groups from the MDR (e.g. MDS-K, CPP-IT)
    
    Parameters:
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    namespace - the namespace from which members will be queried.
    
    Returns:
    
    the namespace members (such as MDS-K, CPP-IT).
    
    Throws:
    
    ExecutionException - if there is an execution error.
  - getUserRootElements
```
public final ResultList getUserRootElements(String languageCode,
                                            String accessToken,
                                            String userAuthId)
                                     throws ExecutionException
```
    Get the root elements from the MDR for a specific user.
    
    Parameters:
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    the root elements (such as MDS-K, CPP-IT).
    
    Throws:
    
    ExecutionException - if there is an execution error.
  - getUserNamespaceRepresentations
```
public final ResultList getUserNamespaceRepresentations(String mdrDataElementId,
                                                        String accessToken,
                                                        String userAuthId)
                                                 throws ExecutionException
```
    Get the representations of a dataelement for a specific users namespace.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAuthId - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    the representations of the dataelement in the users namespace
    
    Throws:
    
    ExecutionException - if there is an execution error.
  - getDataElement
```
public final DataElement getDataElement(String mdrDataElementId,
                                        String languageCode)
                                 throws MdrConnectionException,
                                        MdrInvalidResponseException,
                                        ExecutionException
```
    Get the whole DataElement object from the MDR without authentication.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    languageCode - e.g. "de".
    
    Returns:
    
    The dataelement object
    
    Throws:
    
    MdrConnectionException
    
    MdrInvalidResponseException
    
    ExecutionException
    
    See Also:
    
    getDataElement(String, String, String, String)
  - getDataElement
```
public final DataElement getDataElement(String mdrDataElementId,
                                        String languageCode,
                                        String accessToken,
                                        String userAccessToken)
                                 throws MdrConnectionException,
                                        MdrInvalidResponseException,
                                        ExecutionException
```
    Get the whole DataElement object from the MDR.
    
    Parameters:
    
    mdrDataElementId - e.g. "urn:mdr:dataelement:2:1.0"
    
    languageCode - e.g. "de".
    
    accessToken - Access token, obtained from OSSE.Auth, that should be used on REST calls to the MDR when a user is logged in. Use null for anonymous access.
    
    userAccessToken - The user authentication server id of the user who is logged in. It is used for the cache loader key - the user specific calls are cached across sessions. Use null for anonymous access.
    
    Returns:
    
    The dataelement object
    
    Throws:
    
    MdrConnectionException
    
    MdrInvalidResponseException
    
    ExecutionException
  - cleanCache
```
public final void cleanCache()
```
    Clean the cache.
  - getBaseUri
```
public final URI getBaseUri()
```
    Get the MDR RESTful interface base URI.
    
    Returns:
    
    the MDR RESTful interface base URI

Class MdrClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATH_SEPARATOR

Constructor Detail

MdrClient

MdrClient

MdrClient

MdrClient

MdrClient

MdrClient

Method Detail

getJsonLabel

getRecordLabel

getRecordLabel

getDataElementGroupLabel

getDataElementGroupLabel

getRecordSlots

getRecordSlots

getJsonRecordMembers

getRecordMembers

getRecordMembers

getJsonMembers

getMembers

getMembers

getJson

getJson

getDataElementsFromGroup

getDataElementsFromGroup

getJsonDataElementValidations

getJsonDataElementCatalogue

getJsonCatalogue

getJsonDataElementSlots

getJsonDataElementGroupSlots

getJsonRecordSlots

getJsonCodeSlots

getDataElementSlots

getDataElementSlots

getDataElementGroupSlots

getDataElementGroupSlots

getCode

getCode

getJsonCode

getCodeSlots

getCodeSlots

getJsonSearch

getJsonSearchLocal

getDataElementValidations

getDataElementValidations

getDataElementCatalogue

getDataElementCatalogue

getCatalogue

getCatalogue

search

searchInNamespace

searchLocal

getJsonDataElementDefinition

getJsonDataElement

getJsonRecordDefinition

getDataElementDefinition

getDataElementDefinition

getRecordDefinition

getRecordDefinition

filterMembers

getJsonNamespaces

getJsonNamespaceMembers

getUserJsonRootElements

getNamespaces

getNamespaces

getNamespaceMembers

getNamespaceMembers

getUserRootElements

getUserNamespaceRepresentations

getDataElement

getDataElement

cleanCache

getBaseUri