eu.erasmuswithoutpaper.registryclient

Interface HeiEntry

public interface HeiEntry

Describes a single HEI entry, as found in the EWP Registry's catalogue.

Note, that the EWP Registry keeps only the very import attributes of each HEI (identifiers and name). If you are looking for more information on HEIs, then you should make use of the Institutions API.

Since:

1.2.0

Method Summary

Modifier and Type	Method and Description
String	getId()
String	getName() Get the name of this HEI.
String	getName(String langCode) Get a name in the given language, or null.
String	getNameEnglish() Get the English name of this HEI, or null.
String	getNameNonEnglish() Get a non-English name of this HEI, or null.
Collection<String>	getOtherIds(String type) Retrieve all <other-id> values of certain type.

Method Detail

getId

String getId()

Returns:

SCHAC ID of this HEI.

getName

String getName()

Get the name of this HEI.

Returns:

We will try to return the name in English. If we cannot find it, we will return the name in any other language. If we fail this too, we will return the HEI's ID, so you will never get null here.

getName

String getName(String langCode)

Get a name in the given language, or null.

Please note, that this operates on exact BCP 47 language tag values. This means that, for example, if the HEI name was described with "ru-Latn" xml:lang, then (currently) you won't retrieve this name by asking for "ru". This behavior MAY change in the future (we will probably consider it a backward-compatible change).

Parameters:

langCode - BCP 47 language tag (e.g. "en" or "ru-Latn").

Returns:

String (if exact match was found), or null (if it wasn't).

getNameEnglish

String getNameEnglish()

Get the English name of this HEI, or null.

Returns:

We will try to return the name in English. If we cannot find it, we will return null (this differs from the behavior of getName()).

getNameNonEnglish

String getNameNonEnglish()

Get a non-English name of this HEI, or null.

Returns:

We will try to return the first non-English name of this HEI. If we cannot find it (the HEI supplied only its English name), then null will be returned.

getOtherIds

Collection<String> getOtherIds(String type)

Retrieve all <other-id> values of certain type.

Parameters:

type - type identifier, see RegistryClient.findHei(String, String) for more information on these types.

Returns:

A collection of all matched values for the given type. In no matches were found, an empty collection will be returned.